-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Found inspiration from shiny for Python
- Loading branch information
Showing
3 changed files
with
4,244 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,13 @@ | ||
## Documentation website | ||
|
||
## Getting started | ||
Done with QuartoDoc. Three steps to build and deploy the documentation website: | ||
- Install Quarto CLI, and the QuartoDoc Python package | ||
- Move into the `docs` folder: `cd docs` | ||
- Automatically build the documentation from docstrings: `quartodoc build` | ||
- Deploy the documentation website to GitHub Pages: `quarto publish` | ||
|
||
|
||
## Interactive example with Shiny for Python | ||
- Interactive cells: https://shiny.posit.co/py/ | ||
- Code at: https://github.com/posit-dev/py-shiny/tree/main/docs |
Oops, something went wrong.