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.

Sign up for GitHub

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

Jump to bottom

Restructure Documentation #1679

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
Open

Restructure Documentation #1679

wants to merge 7 commits into from

Commits on Sep 13, 2024

  1. [doc] restructure documentation 

    This does the following things:
- add sphinx to create non-reference/api documentation
- move doxygen stuff into a subdirectory of the sphinx configuration
- enable read-the-docs to host documentation
    @MarcelKoch
    MarcelKoch committed Sep 13, 2024
    Configuration menu
    Copy the full SHA
    c75ee6f View commit details
    Browse the repository at this point in the history

  2. [doc] remove unnecessary linop group 

    The linop group is often added with other groups. These other groups are mostly subgroups of linop, so there is no need to specify it twice.
    @MarcelKoch
    MarcelKoch committed Sep 13, 2024
    Configuration menu
    Copy the full SHA
    07f7efe View commit details
    Browse the repository at this point in the history

  3. [doc] simplify doxygen setup

    @MarcelKoch
    MarcelKoch committed Sep 13, 2024
    Configuration menu
    Copy the full SHA
    8572275 View commit details
    Browse the repository at this point in the history

  4. [doc] generate path to doxygen via cmake

    @MarcelKoch
    MarcelKoch committed Sep 13, 2024
    Configuration menu
    Copy the full SHA
    809c72c View commit details
    Browse the repository at this point in the history

  5. [doc] use fetchcontent to download doxygen-awesome

    @MarcelKoch
    MarcelKoch committed Sep 13, 2024
    Configuration menu
    Copy the full SHA
    8bafb31 View commit details
    Browse the repository at this point in the history

  6. [ci] remove deploying GH pages.

    @MarcelKoch
    MarcelKoch committed Sep 13, 2024
    Configuration menu
    Copy the full SHA
    dee8dfd View commit details
    Browse the repository at this point in the history

  7. [doc] add back link to sphinx from doxygen

    @MarcelKoch
    MarcelKoch committed Sep 13, 2024
    Configuration menu
    Copy the full SHA
    b54adfb View commit details
    Browse the repository at this point in the history