Skip to content

Add http.server reference to quickly serve the built site #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
choldgraf merged 2 commits into from
Jan 10, 2022
Merged

Add http.server reference to quickly serve the built site #4

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2fe7afe
Add http.server reference to quickly serve the built site
damianavila Jan 10, 2022
f0fefe9
Update docs/contribute/setup.md
choldgraf Jan 10, 2022
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
8 changes: 8 additions & 0 deletions docs/contribute/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,14 @@ They will be placed in a `docs/_build/html` folder.
If the docs have already been built, it will only build new pages that have been updated.
You can open one of the HTML files there to preview the documentation locally.

Alternatively, you can invoke the built-in Python [http.server](https://docs.python.org/3/library/http.server.html#module-http.server) with:

```console
$ python -m http.server -d _build/html/
```

This will print a local URL that you can open in a browser to explore the HTML files.

### Change content and re-build

Now that you've built the documentation, edit one of the source files to see how the documentation updates with new builds.
Expand Down