File tree Expand file tree Collapse file tree 1 file changed +41
-0
lines changed Expand file tree Collapse file tree 1 file changed +41
-0
lines changed Original file line number Diff line number Diff line change
1
+ # Building the docs
2
+
3
+ This guide goes through how to build the NumPy-Financial documentation with poetry
4
+
5
+ ## Assumptions
6
+
7
+ This guide assumes that you have set up poetry and a virtual environment. If you have
8
+ not done this please read [ building_with_poetry] ( building_with_poetry.md ) .
9
+
10
+ You can check that poetry is installed by running:
11
+
12
+ ``` shell
13
+ poetry -V
14
+ ```
15
+
16
+ ## Installing the documentation dependencies
17
+
18
+ NumPy-Financial is built using [ sphinx] ( https://www.sphinx-doc.org/en/master/ ) with [ numpydoc] ( https://numpydoc.readthedocs.io/en/latest/ ) .
19
+
20
+ The dependencies can be installed using poetry and the `` docs `` group:
21
+
22
+ ``` shell
23
+ poetry install --with docs
24
+ ```
25
+
26
+ ## Building the documentation
27
+
28
+ The documentation is located in the `` doc `` directory. The first step is to change directory into this directory
29
+
30
+ ``` shell
31
+ cd doc
32
+ ```
33
+
34
+ Once you are in the `` doc `` directory, the documentation can be built using `` make `` .
35
+
36
+ ``` shell
37
+ poetry run make html
38
+ ```
39
+
40
+ This will create the docs as a html document in the `` build `` directory. Note that there are several options available,
41
+ however, only the html documentation is built officially.
You can’t perform that action at this time.
0 commit comments