Skip to content

Commit e22135e

Browse files
committed
Alert programmer to merge documentation into gh-pages before building.
1 parent 4a41017 commit e22135e

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/documentation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ All the Python code must follow `PEP 8`_. The docstrings must follow `Google's s
1414
Building Documentation
1515
----------------------
1616

17-
The documentation framework used is Sphinx. To build the documentation, switch the current branch to gh-pages.
17+
The documentation framework used is Sphinx. To build the documentation, switch the current branch to gh-pages and merge documentation into gh-pages.
1818
After, execute ``sphinx-build . ..`` in the docs/ directory. This would cause all the documentation to be built.
1919
The resulting files are now in the root project and can be viewed by Github pages.
2020

0 commit comments

Comments
 (0)