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

added package template #48

Merged
merged 6 commits into from
Jan 25, 2025
Merged

added package template #48

merged 6 commits into from
Jan 25, 2025

Conversation

Green-zy
Copy link
Collaborator

@Green-zy Green-zy commented Jan 24, 2025

I added 4 ipynb files for our function usage documentation.
The template is built, below is the html overview.
image
We can finish our own function documentation in the corresponding .ipynb file in doc/
image

When we render locally, please:

  1. Go to repo dictionary, in Bash:
  • $ poetry add --group dev myst-nb sphinx-autoapi sphinx-rtd-theme
  • $ pip install sphinx-material
  1. then go to docs/, make html
  2. go to docs/_build/html, double click index.md

Copy link
Collaborator

@zze1999 zze1999 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, it looks great!

@HrayrMuradyan
Copy link
Collaborator

It looks good to me, I can merge it if all agree.

@HrayrMuradyan HrayrMuradyan merged commit 571c04a into main Jan 25, 2025
2 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants