Skip to content

Missing docs#124

Merged
abachma2 merged 4 commits into
arfc:masterfrom
yardasol:missing-docs
Feb 11, 2022
Merged

Missing docs#124
abachma2 merged 4 commits into
arfc:masterfrom
yardasol:missing-docs

Conversation

@yardasol

@yardasol yardasol commented Feb 8, 2022

Copy link
Copy Markdown
Contributor

Summary of changes

This PR adds the jsonschema package to the doc-environment.yml file, which allows for the Python API to be fully built in the online docs.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Required for Merging

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
  • My change is a source code change
    • I have added/modified tests to cover my changes
    • I have explained why my change does not require new/modified tests
  • All new and existing tests passed.
    • CI tests pass
    • Local tests pass (including Serpent2 integration tests)
  • I have recorded my changes in the changelog for the upcoming release

Note: these changes were already added to the changelog for v0.4.0 in #98 but did not actually include the documented change itself. This PR fixes that.

Associated Issues and PRs

Associated Developers

Checklist for Reviewers

Reviewers should use this link to get to the
Review Checklist before they begin their review.

@yardasol yardasol requested review from abachma2 and munkm February 8, 2022 19:16
@yardasol yardasol added this to the 0.4.0 milestone Feb 8, 2022
@yardasol yardasol marked this pull request as ready for review February 8, 2022 19:17

@abachma2 abachma2 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good to me!

@abachma2 abachma2 merged commit 498effa into arfc:master Feb 11, 2022
github-actions Bot pushed a commit that referenced this pull request Feb 14, 2022
@yardasol yardasol deleted the missing-docs branch March 9, 2022 19:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: Missing app, test_app, and test_simulation modules in the 0.4.0 API docs

2 participants