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

Update doc_tools and clean up GenX docs #193

Conversation

RuaridhMacd
Copy link
Collaborator

Description

Resolves issues we were having integrating GenX documentation.

Previously, the GenX documentation was automatically being merged with the DOLPHYN documentation. This led to repeat calls to documentation for some functions with the same names in both codebases. Sometimes, this just led to warnings when building the documentation, but at other times the function doctoring would only be successfully added to the doc in one place, leaving gaps elsewhere.

Fixes issue #

Resolves #192

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.

The documentation now builds locally for me.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have run tests with my code to avoid compatibility issues
  • Any dependent changes have been merged and published in downstream modules

@RuaridhMacd RuaridhMacd added bug Something isn't working documentation Improvements or additions to documentation labels Oct 31, 2023
@RuaridhMacd RuaridhMacd requested a review from bennettm October 31, 2023 17:02
@RuaridhMacd RuaridhMacd linked an issue Oct 31, 2023 that may be closed by this pull request
1 task
docs/src/policies.md Show resolved Hide resolved
@bennettm bennettm merged commit ec7b59e into main Nov 1, 2023
1 check passed
@RuaridhMacd RuaridhMacd deleted the 192-bug-documentation-for-functions-in-dolphyn-and-genx-not-showing-properly branch February 2, 2024 16:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] Documentation for functions in DOLPHYN and GenX not showing properly
2 participants