Skip to content

Commit

Permalink
📚 Add local build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
daquintero committed Jul 31, 2024
1 parent 168ec6e commit 0abed21
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ When we have highly complex classes that have multiple inherited parameters, it

The idea is that we can use the `autoflex` directive to improve the data structure generated during the `autosummary` process instead of the `automodule` or `autoclass` directive.

Build the local documentation basically:

```bash
poetry run python -m sphinx docs/ _docs/
```

Basic Example:

```rst
Expand Down

0 comments on commit 0abed21

Please sign in to comment.