This repository has been archived by the owner on Dec 7, 2022. It is now read-only.
Migrates README.rst content into the sphinx built project #60
Conversation
This file contains 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
|
Looks like maybe flake8 should exclude the docs/conf.py file or all those issues should be addressed, but since it seems that was a problem before this PR it's not a blocker for me. Looks good! |
- Maintains a basic description in the README which links to the rest content in it's new location. - Also fixes several formatting errors which Sphinx identified This causes `make html` to produce html output that looks good without any warnings or errors. - Adds a flake8 ignore statement to ignore the docs/conf.py file Prior to this the build process would fail with: ``` Sphinx error: master file /home/bmbouter/devel/working/crane/docs/index.rst not found ``` This commit is designed to restructure the current docs so it is being merged to 2.0-release and merged forward from there. https://pulp.plan.io/issues/950 re #950
|
@jeremycline Thanks for the review. Configuring |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
the rest content in it's new location.
This causes
make htmlto produce html output that looksgood without any warnings or errors.
Prior to this the build process would fail with:
This commit is designed to restructure the current docs so it is
being merged to 2.0-release and merged forward from there.
https://pulp.plan.io/issues/950
re #950