Commit 3ebcd3a8 authored by Domanski, Marian M.'s avatar Domanski, Marian M.
Browse files

add docs build instructions to readme

parent 7c6f3503
......@@ -42,9 +42,9 @@ to set up SSH.
* Log in to your USGS GitLab account at [code.usgs.gov](code.usgs.gov).
* Create an SSH key and add it to your GitLab account by following the
instructions beginning [here](https://code.usgs.gov/help/ssh/README.md#generating-a-new-ssh-key-pair). Follow the instructions under
**Generating a new SSH key pair** and **Adding an SSH key to your GitLab
account**.
instructions beginning [here](https://code.usgs.gov/help/ssh/README.md#generating-a-new-ssh-key-pair).
Follow the instructions under **Generating a new SSH key pair** and **Adding an
SSH key to your GitLab account**.
* You want to use RSA when generating a new SSH key pair.
......@@ -143,3 +143,23 @@ OK
The tests passing is a clear indicator that the FluEgg environment has been set
up correctly. You're ready to begin working with the code.
#### 8. Build the code documentation
Currently, only the docstrings within the FluEgg code are available in the
documentation.
To build the documentation, run the command `python setup.py build_sphinx` from
the prompt. The output will look something like the below text.
```
(fluegg) C:\path-to-sources\fluegg>python setup.py build_sphinx
running build_sphinx
*build process output*
The HTML pages are in docs\_build\html.
```
To view the generated HTML documentation, open the file
`path-to-sources\fluegg\docs\_build\html\index.html` in a browser. Again,
`path-to-sources\fluegg` is the top-level directory of the FluEgg project on
your machine.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment