Skip to content

Feature: Documentation Website Buildout#70

Open
kylegodbey wants to merge 2 commits intobeykyle:mainfrom
kylegodbey:newdocs
Open

Feature: Documentation Website Buildout#70
kylegodbey wants to merge 2 commits intobeykyle:mainfrom
kylegodbey:newdocs

Conversation

@kylegodbey
Copy link

This pull request introduces a documentation build and deployment workflow for GitHub Pages and adds or updates API documentation files for several modules in the project. The changes are primarily focused on improving the structure, accessibility, and deployment of the project's documentation.

Documentation workflow and deployment:

  • Added a new GitHub Actions workflow (.github/workflows/gh-pages.yml) to automate building and deploying documentation to GitHub Pages whenever changes are pushed to the main branch. This workflow sets up Python, installs dependencies, builds the docs using MkDocs, and deploys the output.

API documentation structure:

  • Added or updated Markdown files for API documentation of various modules (e.g., jitr.data, jitr.optical_potentials, jitr.reactions, jitr.utils, jitr.quadrature, jitr.xs, jitr.rmatrix) in both api/ and docs/api/ directories. These files use MkDocs/Mike syntax to provide structured and navigable documentation, including options for headings and table of contents. [1] [2] [3] [4] [5] [6] [7]

  • Updated SUMMARY.md to include links to the new or updated API documentation files, improving navigation for users browsing the documentation.

Additional API documentation:

  • Added documentation stubs for specific submodules and functions, such as jitr.compute, jitr.config, jitr.visualize, and specific reaction types under jitr.xs, to ensure comprehensive coverage of the codebase in the documentation. [1] [2] [3] [4] [5] [6]

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.

1 participant