Skip to content
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.

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

Create script to generate jupedsim.org website locally #1343

Open
Ozaq opened this issue Mar 8, 2024 · 0 comments
Open

Create script to generate jupedsim.org website locally #1343

Ozaq opened this issue Mar 8, 2024 · 0 comments
Labels

Comments

@Ozaq
Copy link
Contributor

Ozaq commented Mar 8, 2024

We rely on GH-Actions right now to generate the website content however when updating the documentation it is sometimes handy to be able to quickly build everything locally. The process is not very complicated and boils (almost) down to:

pip install -r docs/requirements
pip install . sphinx-build -T -b html docs/source docs/build -j

# optionally exclude notebooks
nb_execution_excludepatterns = [] # insert pattern to exclude all or specific notebooks

This should be packed into a nice (probably python) cli tool.

@Ozaq Ozaq added the Tooling label Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant