Skip to content

Commit

Permalink
Docs: fix autobuild command (#462)
Browse files Browse the repository at this point in the history
  • Loading branch information
Guts authored Mar 29, 2024
2 parents 8bad212 + ae78436 commit 397cb1f
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,7 @@ instance/
.scrapy

# Sphinx documentation
docs/_build/
docs/_apidoc/
docs/_*
public/

# PyBuilder
Expand Down
4 changes: 2 additions & 2 deletions docs/development/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ Open `docs/_build/index.html` in a web browser.
## Write documentation using live render

```sh
sphinx-autobuild -b html docs/ docs/_build
sphinx-autobuild -b html docs/ docs/_autobuild/ --delay 3 --open-browser --ignore docs/misc/dependencies.md --ignore docs/usage/download_section.md
```

Open <http://localhost:8000> in a web browser to see the HTML render updated when a file is saved.
Your default web browser should be automatically opened on <http://localhost:8000> displaying the HTML render which will be updated when a file is saved.

---

Expand Down

0 comments on commit 397cb1f

Please sign in to comment.