Skip to content

Commit

Permalink
Found inspiration from shiny for Python
Browse files Browse the repository at this point in the history
  • Loading branch information
ddrous committed Apr 6, 2024
1 parent 38c8463 commit a921820
Show file tree
Hide file tree
Showing 3 changed files with 4,244 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ quadqs_statistics.json
docs/.quarto/*
docs/_site/*

!updec/tests/data/mesh.msh
!updes/tests/data/mesh.msh

demos/Laplace/data/*
!demos/Laplace/data/README.md
Expand Down
6 changes: 6 additions & 0 deletions docs/README.md
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
Loading

0 comments on commit a921820

Please sign in to comment.