Skip to content

Commit fba5115

Browse files
committed
DOC: Document how to build the docs with conda and spin
1 parent b6573ef commit fba5115

File tree

2 files changed

+12
-21
lines changed

2 files changed

+12
-21
lines changed

doc/source/dev/building_the_docs.md

Lines changed: 9 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,26 @@ This guide goes through how to build the NumPy-Financial documentation with poet
55
## Assumptions
66

77
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).
99

10-
You can check that poetry is installed by running:
10+
You can check that conda and spin are installed by running:
1111

1212
```shell
13-
poetry -V
13+
conda -V
1414
```
1515

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-
2216
```shell
23-
poetry install --with docs
17+
spin -V
2418
```
2519

2620
## Building the documentation
2721

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.
3523

3624
```shell
37-
poetry run make html
25+
spin docs -j 1
3826
```
3927

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+

doc/source/dev/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@ Development
55
:maxdepth: 1
66

77
getting_the_code.md
8-
building_with_poetry.md
8+
building_with_spin.md
99
running_the_benchmarks.md
10+
building_the_docs.md
11+
checking_out_an_upstream_pr.md
1012

1113

1214
.. include:: ../_includes/release-notes.rst

0 commit comments

Comments
 (0)