Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
FluEgg
fluegg
Commits
3ebcd3a8
Commit
3ebcd3a8
authored
Aug 06, 2019
by
Domanski, Marian M.
Browse files
add docs build instructions to readme
parent
7c6f3503
Changes
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
3ebcd3a8
...
...
@@ -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.
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment