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

Introduce the infrastructure for auto-generating API documentation via sphinx and doxygen #383

Merged
merged 25 commits into from
Jan 19, 2024
Merged

Introduce the infrastructure for auto-generating API documentation via sphinx and doxygen #383

merged 25 commits into from
Jan 19, 2024

Commits on Jan 18, 2024

  1. [doxygen] Update doxygen config file 

    doxygen -u Doxyfile.in
    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    dc2877d View commit details
    Browse the repository at this point in the history

  2. [doxygen] Make generated pages readable again

    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    2adad88 View commit details
    Browse the repository at this point in the history

  3. [wip] Add basic sphinx setup

    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    48effcc View commit details
    Browse the repository at this point in the history

  4. [wip] Make sphinx pick up doxygen output for c++ API

    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    2b597a3 View commit details
    Browse the repository at this point in the history

  5. [doc] Configure conf.py via cmake

    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    b588878 View commit details
    Browse the repository at this point in the history

  6. [doc] Make sphinx generate API docs for python bindings

    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    cdebf33 View commit details
    Browse the repository at this point in the history

  7. [doc] Remove no longer necessary html and style files

    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    58fe447 View commit details
    Browse the repository at this point in the history

  8. Avoid installing the build subfolder

    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    10ca278 View commit details
    Browse the repository at this point in the history

  9. [wip] First attempt at getting readthedocs setup

    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    aa83600 View commit details
    Browse the repository at this point in the history

  10. [wip] Add requirements for readthedocs

    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    cf621fd View commit details
    Browse the repository at this point in the history

  11. [wip] First attempt at running doxygen

    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    4f0fa33 View commit details
    Browse the repository at this point in the history

  12. [wip] More doxygen tuning and addition of python auto generation

    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    c610c9f View commit details
    Browse the repository at this point in the history

  13. Integrate generation back into cmake

    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    e5b9860 View commit details
    Browse the repository at this point in the history

  14. Make pre-commit happy

    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    ccc49c6 View commit details
    Browse the repository at this point in the history

  15. Properly ignore tests and podio_version

    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    a7d0d3d View commit details
    Browse the repository at this point in the history

  16. Fix minor warning from autodoc

    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    66d0075 View commit details
    Browse the repository at this point in the history

  17. Import from the correct place

    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    d8b2997 View commit details
    Browse the repository at this point in the history

  18. Add a workflow for building the docs

    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    1c62191 View commit details
    Browse the repository at this point in the history

  19. Make the documentation target depend on the necessary libs

    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    7ab0e61 View commit details
    Browse the repository at this point in the history

  20. Remove readthedocs config and use pip-compile to nail down deps

    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    db47328 View commit details
    Browse the repository at this point in the history

  21. Remove doc/conf.py from gitignore since it is no longer configured

    @tmadlener
    tmadlener committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    c720965 View commit details
    Browse the repository at this point in the history

Commits on Jan 19, 2024

  1. Remove debugging branch trigger

    @tmadlener
    tmadlener authored Jan 19, 2024
    Configuration menu
    Copy the full SHA
    9e4e6e1 View commit details
    Browse the repository at this point in the history

  2. Cleanup sphinx config

    @tmadlener
    tmadlener authored Jan 19, 2024
    Configuration menu
    Copy the full SHA
    3e8c9c1 View commit details
    Browse the repository at this point in the history

  3. Make filename and workflow name agree

    @tmadlener
    tmadlener committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    cbab859 View commit details
    Browse the repository at this point in the history

  4. Fix newline

    @tmadlener
    tmadlener committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    a84c005 View commit details
    Browse the repository at this point in the history