Skip to content

Commit

Permalink
docs: doc the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
antazoey committed Sep 6, 2024
1 parent 8478ab1 commit 5c5e848
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 11 deletions.
10 changes: 6 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,19 +58,21 @@ pip install -e .'[doc]'
Then, run the following from the root project directory:

```bash
python build_docs.py
sphinx-ape build .
```

For the best viewing experience, use a local server:

```bash
python -m http.server --directory "docs/_build/" --bind 127.0.0.1 1337
sphinx-ape serve .
```

Then, open your browser to `127.0.0.1:1337` and click the `ape` directory link.

```{note}
Serving from `"docs/_build/"` rather than `"docs/_build/ape"` is necessary to make routing work.
You can also use the `--open` flag to automatically open the docs:

```bash
sphinx-ape serve . --open
```

## Pull Requests
Expand Down
8 changes: 1 addition & 7 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,7 @@
"mdformat-pyproject>=0.0.1", # Allows configuring in pyproject.toml
],
"doc": [
"pygments>=2.17.0,<3", # Needed for the Vyper lexer
"myst-parser>=1.0.0,<2", # Parse markdown docs
"sphinx-click>=4.4.0,<5", # For documenting CLI
"Sphinx>=6.1.3,<7", # Documentation generator
"sphinx_rtd_theme>=1.2.0,<2", # Readthedocs.org theme
"sphinxcontrib-napoleon>=0.7", # Allow Google-style documentation
"sphinx-plausible>=0.1.2,<0.2",
"sphinx-ape @ git+ssh://[email protected]/ApeWorX/sphinx-ape@feat/actionable"
],
"release": [ # `release` GitHub Action job uses this
"setuptools", # Installation tool
Expand Down

0 comments on commit 5c5e848

Please sign in to comment.