File tree Expand file tree Collapse file tree 2 files changed +12
-21
lines changed Expand file tree Collapse file tree 2 files changed +12
-21
lines changed Original file line number Diff line number Diff line change @@ -5,37 +5,26 @@ This guide goes through how to build the NumPy-Financial documentation with poet
5
5
## Assumptions
6
6
7
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 ) .
8
+ not done this please read [ building_with_spin ] ( building_with_spin ) .
9
9
10
- You can check that poetry is installed by running:
10
+ You can check that conda and spin are installed by running:
11
11
12
12
``` shell
13
- poetry -V
13
+ conda -V
14
14
```
15
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
16
``` shell
23
- poetry install --with docs
17
+ spin -V
24
18
```
25
19
26
20
## Building the documentation
27
21
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 `` .
22
+ spin handles building the documentation for us. All we have to do is invoke the built-in command.
35
23
36
24
``` shell
37
- poetry run make html
25
+ spin docs -j 1
38
26
```
39
27
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.
28
+ This will create the docs as a html document in the `` doc/build `` directory. Note that there are several options
29
+ available, however, only the html documentation is built officially.
30
+
Original file line number Diff line number Diff line change @@ -5,8 +5,10 @@ Development
5
5
:maxdepth: 1
6
6
7
7
getting_the_code.md
8
- building_with_poetry .md
8
+ building_with_spin .md
9
9
running_the_benchmarks.md
10
+ building_the_docs.md
11
+ checking_out_an_upstream_pr.md
10
12
11
13
12
14
.. include :: ../_includes/release-notes.rst
You can’t perform that action at this time.
0 commit comments