Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure Readthedocs documentation #3428

Merged
merged 2 commits into from
May 23, 2023

Conversation

vishalvvr
Copy link
Member

@vishalvvr vishalvvr commented May 22, 2023

Pbench docs(Readthedocs) need a rework, so this is the first step toward documentation efforts.
This is just a structural change, this commit does not intend to make content-level changes.

Changes:

  • New directory structure.
  • Copy existing Contributing, Server API doc, getting started, user guide, and system design files to new dir
  • Add support for markdown files(earlier it was only reStructuredText).

Demo link:
https://pb-readthedocs.readthedocs.io

PBENCH-1152

Pbench docs(Readthedocs) need some rework, so this is the first step towards documentation efforts.
This is just a structural change, this commit does not intend to make content level changes.

Changes:
- New directory structure.
- Copy existing Contributing, Server API doc, getting started, user
guide and system design files to new dir
- Add support for markdown files(earlier it was only reStructuredText).
@dbutenhof
Copy link
Member

  • black --check .
    would reformat docs/conf.py

I'm not sure we should be black checking anything under docs, so one option would be to add this to the exclusion list (pyproject.toml)

Copy link
Member

@dbutenhof dbutenhof left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to fix the black issue, either by formatting the conf.py or (I think preferably) excluding it and probably the entire docs tree.

docs/Agent/installation/index.rst Outdated Show resolved Hide resolved
- fix the black package formatting issue
- rephrased sentence in agent installation file
@vishalvvr
Copy link
Member Author

You need to fix the black issue, either by formatting the conf.py or (I think preferably) excluding it and probably the entire docs tree.

Fixed

Copy link
Member

@dbutenhof dbutenhof left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would have slightly preferred changing the configuration to exclude the conf.py file (and probably everything under docs/), but I guess this works and I suppose it's unlikely there will be any more. So let's just get this in and move on.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants