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

Added sphinx setup and reformatted existing docs to rst format #178

Merged
merged 5 commits into from
Mar 1, 2019

Conversation

webbyfox
Copy link

@webbyfox webbyfox commented Feb 28, 2019

To install sphinx:
Run:
pip install -U Sphinx
Then cd docs/ and run
make html

which should generate a _build folder with HTML of documentation which can be browsed.

Copy link
Contributor

@monikasulik monikasulik left a comment

Choose a reason for hiding this comment

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

Since you're changing where some of the docs are now, you might need to update Noel's confluence page to point to the correct place.
Also, might be nice to put the command that generates docs into the README and put a note that it creates them in the docs/ folder (I know that's very standard, but technically it's configurable AFAIK).

docs/signals.rst Outdated Show resolved Hide resolved
@webbyfox webbyfox merged commit 0c624c6 into master Mar 1, 2019
@marksweb marksweb deleted the feature/FIL-933-sphinx-setup branch November 26, 2022 11:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants