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

Doxysphinx #110

Draft
wants to merge 12 commits into
base: develop
Choose a base branch
from
Draft

Doxysphinx #110

wants to merge 12 commits into from

Conversation

zmoon
Copy link
Collaborator

@zmoon zmoon commented Dec 5, 2024

Doxysphinx integrates the Doxygen-generated HTML into Sphinx-based documentation.

Currently the original Doxygen docs are still going too.

Some notes:

  • seems like most pages (e.g. those for a file, derived type, etc.) aren't recognized as part of the API tree
  • search in RTD doesn't seem to be working properly

Building the docs locally (from the docs/ directory):

  1. Run Doxygen

    doxygen
    
  2. Run Doxysphinx

    doxysphinx -v INFO build . ./_build Doxyfile
    
  3. Run Sphinx

    sphinx-build -b html . ./_build
    

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