Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions doc_developer/building_the_docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Building the docs

This guide goes through how to build the NumPy-Financial documentation with poetry

## Assumptions

This guide assumes that you have set up poetry and a virtual environment. If you have
not done this please read [building_with_poetry](building_with_poetry.md).

You can check that poetry is installed by running:

```shell
poetry -V
```

## Installing the documentation dependencies

NumPy-Financial is built using [sphinx](https://www.sphinx-doc.org/en/master/) with [numpydoc](https://numpydoc.readthedocs.io/en/latest/).

The dependencies can be installed using poetry and the ``docs`` group:

```shell
poetry install --with docs
```

## Building the documentation

The documentation is located in the ``doc`` directory. The first step is to change directory into this directory

```shell
cd doc
```

Once you are in the ``doc`` directory, the documentation can be built using ``make``.

```shell
poetry run make html
```

This will create the docs as a html document in the ``build`` directory. Note that there are several options available,
however, only the html documentation is built officially.