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

First implementation of docs #47

Merged
merged 33 commits into from
Jan 27, 2025
Merged

First implementation of docs #47

merged 33 commits into from
Jan 27, 2025

Conversation

aknierim
Copy link
Member

  • Add a first (simple) implementation of docs for pyvisgen
  • This is still WIP, some fixes are necessary for the automodapi summary generation of pyvisgen.layouts and pyvisgen.gridding

@aknierim aknierim added the documentation Improvements or additions to documentation label Dec 6, 2024
Copy link

codecov bot commented Jan 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.28%. Comparing base (17b315a) to head (ef8ca8f).
Report is 34 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #47      +/-   ##
==========================================
- Coverage   88.53%   88.28%   -0.25%     
==========================================
  Files          13       19       +6     
  Lines        1151     1238      +87     
==========================================
+ Hits         1019     1093      +74     
- Misses        132      145      +13     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@aknierim aknierim marked this pull request as ready for review January 25, 2025 14:19
@aknierim aknierim requested a review from Kevin2 January 25, 2025 14:20
@aknierim
Copy link
Member Author

aknierim commented Jan 25, 2025

To build the docs, run

$ make -C docs/  html

from the root directory. Once built, you can check out the html pages locally by running

$ python -m http.server docs/_build/html

and open the docs on the served address.

@aknierim aknierim merged commit 230a84d into main Jan 27, 2025
5 of 6 checks passed
@aknierim aknierim deleted the docs branch January 27, 2025 10:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants