Skip to content
Merged
Show file tree
Hide file tree
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
13 changes: 6 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,20 +167,19 @@ We recommend that your contribution complies with the following guidelines befor

## Building the documentation locally

A local build of the docs is achieved by:
To build the documentation, run from the **project root**:

```bash
cd docs
make html
```

Sometimes not all changes are recognised. In that case run this (again from within the `docs` folder):

To clean and rebuild the documentation from scratch:
```bash
make clean && make html
make cleandocs
make html
```
Docs are built in docs/_build/html, but these docs are not committed to the GitHub repository due to .gitignore.

Docs are built in `docs/_build`, but these docs are _not_ committed to the GitHub repository due to `.gitignore`.
📌 Note: The previous docs/Makefile has been removed. Please use only the root-level Makefile for documentation commands

## Overview of code structure

Expand Down
11 changes: 10 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: init lint check_lint test
.PHONY: init lint check_lint test uml html cleandocs

init:
python -m pip install -e . --no-deps
Expand All @@ -20,3 +20,12 @@ test:

uml:
pyreverse -o png causalpy --output-directory docs/source/_static --ignore tests

# Docs build commands

html:
sphinx-build -b html docs/source docs/_build

cleandocs:
rm -rf docs/_build
rm -rf docs/source/api/generated
20 changes: 0 additions & 20 deletions docs/Makefile

This file was deleted.