Restructure Readthedocs documentation #3428
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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).
Member
I'm not sure we should be |
dbutenhof
requested changes
May 22, 2023
Member
dbutenhof
left a comment
dbutenhof
left a comment
There was a problem hiding this comment.
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
riya-17
approved these changes
May 23, 2023
Member
Author
Fixed |
dbutenhof
approved these changes
May 23, 2023
Member
dbutenhof
left a comment
dbutenhof
left a comment
There was a problem hiding this comment.
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
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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