forked from python-hydro/pyro2
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathnotes.txt
More file actions
42 lines (21 loc) · 872 Bytes
/
Copy pathnotes.txt
File metadata and controls
42 lines (21 loc) · 872 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
To build the webpages (run from docs/):
make html
To automatically generate the API docs (run from repository root):
sphinx-apidoc -l -f -M -o docs/source/ pyro/
(-M puts the module before submodule in the API pages; any files/directories after pyro/ are excludes)
To support notebooks:
pip3 install nbsphinx --user
dnf install pandoc
dnf install python3-ipython-sphinx
For numpy doc format:
pip3 install numpydoc --user
For the theme:
pip install sphinx_rtd_theme
Youtube:
https://bitbucket.org/birkenfeld/sphinx-contrib/src/49a8e96bc8a7/youtube/
https://github.com/rtfd/readthedocs.org/issues/879
button:
https://github.com/conda/conda-docs/blob/master/web/button.py
https://stackoverflow.com/questions/25088113/make-a-css-button-a-link-in-sphinx
https://buttons.github.io/
http://docs.readthedocs.io/en/latest/guides/adding-custom-css.html