You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In Python, we use formatted docstrings to generate our code-level documentation.
12
12
We then use a tool called [`sphinx`](https://www.sphinx-doc.org/en/master/index.html)
13
-
to take those formatted docstrings to generate our API reference documentation
13
+
to take those formatted docstrings to generate our API reference documentation
14
14
for our package website, and several of our Markdown files in our packages
15
-
GitHub repository to generate other pages for our package website
15
+
GitHub repository to generate other pages for our package website
16
16
(Contributing, Code of Conduct, etc).
17
17
We then serve the website up on some platform, such as [Read the Docs](https://readthedocs.org/)
18
18
(others exist as well).
@@ -65,7 +65,7 @@ that are needed for this to work.
65
65
-------
66
66
bool
67
67
Description of return value
68
-
68
+
69
69
Examples
70
70
--------
71
71
>>> my_funtion(4)
@@ -82,23 +82,23 @@ How do we add new pages to our Python package-level documentation? The pages tha
82
82
83
83
Let's take a look at the [raw version of that file from our `pypkgs-cookiecutter`](https://raw.githubusercontent.com/py-pkgs/py-pkgs-cookiecutter/main/%7B%7B%20cookiecutter.__package_slug%20%7D%7D/docs/index.md):
84
84
85
-
<imgsrc="img/index-raw.png"width=300>
85
+
<imgsrc="../img/index-raw.png"width=300>
86
86
87
87
This results in a side bar on our webpage that looks like this:
88
88
89
-
<imgsrc="img/original-index.png"width=700>
89
+
<imgsrc="../img/original-index.png"width=700>
90
90
91
91
Thus, to add new pages, we add them to the `toctree` list. They will then show up in that position in the rendered side bar.
92
92
93
93
What if we want headers in our side bar?
94
94
To do this, we need to add multiple `toctree`'s and add a caption.
0 commit comments