-
Notifications
You must be signed in to change notification settings - Fork 108
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
Restructure Readthedocs documentation #3428
Conversation
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).
I'm not sure we should be |
There was a problem hiding this 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.
- fix the black package formatting issue - rephrased sentence in agent installation file
Fixed |
There was a problem hiding this 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.
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:
Demo link:
https://pb-readthedocs.readthedocs.io
PBENCH-1152