This repository has been archived by the owner on Mar 13, 2024. It is now read-only.
Readthedocs #3
Merged
Readthedocs #3
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
The added docs structure provides a starting point for creating project documentation using Sphinx.
Remove some unnecessarily repeated strings in conf.py and replace them with variables.
GDYendell
approved these changes
Jan 30, 2019
|
@yousefmoazzam merge this whenever your're ready. What is it being used for, out of interest? |
GDYendell
reviewed
Jan 31, 2019
Update README.rst to include the use of the docs directory, and add a link to a Confluence page detailing how to set up readthedocs to build and host the project's documentation.
yousefmoazzam
force-pushed
the
readthedocs
branch
from
26dddd8
to
b69786d
Compare
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.
This adds a docs structure which can be used to create documentation using Sphinx, and have it automatically built and hosted by readthedocs.
The main points of interest are the docs/index.rst file which is the place for users to start adding their own documentation (it contains a few basic examples of the different types of content that can be created by Sphinx to help the user get started), and the added link in the README.rst which goes over how to configure readthedocs and github to enable the automatic building and hosting behaviour of readthedocs.
It's worth mentioning that the docs structure included here is taken from https://github.com/thomascobb/pvi.