Feature: Documentation Website Buildout#70
Open
kylegodbey wants to merge 2 commits intobeykyle:mainfrom
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
.github/workflows/gh-pages.yml) to automate building and deploying documentation to GitHub Pages whenever changes are pushed to themainbranch. 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 bothapi/anddocs/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.mdto include links to the new or updated API documentation files, improving navigation for users browsing the documentation.Additional API documentation:
jitr.compute,jitr.config,jitr.visualize, and specific reaction types underjitr.xs, to ensure comprehensive coverage of the codebase in the documentation. [1] [2] [3] [4] [5] [6]