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 sphinx-based website #210

Open
tkittel opened this issue Dec 5, 2024 · 3 comments
Open

Create sphinx-based website #210

tkittel opened this issue Dec 5, 2024 · 3 comments

Comments

@tkittel
Copy link
Member

tkittel commented Dec 5, 2024

We have discussed this for years, but apparently there is not a dedicated issue for it yet: NCrystal needs a proper website. It should be based on sphinx and live in the main repo similarly to how it is done for e.g. the simplebuild project: https://mctools.github.io/simplebuild/

There are many many tasks to mention in this regard, but I am opening this issue to have a place to note them down.

@tkittel
Copy link
Member Author

tkittel commented Dec 5, 2024

Related to the data library page which @MilanKlausz is working on in #168.

@tkittel
Copy link
Member Author

tkittel commented Dec 5, 2024

Idea: show various charts on development subpages with: https://pypi.org/project/sphinxcontrib-mermaid/ (e.g. dependency graph between the coding modules that will be introduced in v4.0.0).

@tkittel
Copy link
Member Author

tkittel commented Dec 5, 2024

We also need the tutorial notebooks integrated. And a "material cookbook" page, and cfg-string docs, and CLI tools argparse docs, and discussion about the physics, etc. etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant