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

Document one class per html page and list all inherited members. #1952

Merged
merged 30 commits into from
Nov 26, 2024
Merged

Document one class per html page and list all inherited members. #1952

merged 30 commits into from
Nov 26, 2024

Commits on Nov 19, 2024

  1. Start the process of automatically generating the toctrees. 

    To do this, we need to be able to import hoomd from the source directory.
I prefer not to add additional dependencies (Mock), so we include
manually prepared mock files to make the import possible.
    @joaander
    joaander committed Nov 19, 2024
    Configuration menu
    Copy the full SHA
    f5f9421 View commit details
    Browse the repository at this point in the history

  2. Autogenerate the docs for a few test modules.

    @joaander
    joaander committed Nov 19, 2024
    Configuration menu
    Copy the full SHA
    76a1719 View commit details
    Browse the repository at this point in the history

Commits on Nov 20, 2024

  1. Convert the base hooomd module to the new doc layout.

    @joaander
    joaander committed Nov 20, 2024
    Configuration menu
    Copy the full SHA
    5659ca7 View commit details
    Browse the repository at this point in the history

  2. Fix doc references.

    @joaander
    joaander committed Nov 20, 2024
    Configuration menu
    Copy the full SHA
    fa331b7 View commit details
    Browse the repository at this point in the history

  3. Port HPMC and MPCD to generate-toctree.

    @joaander
    joaander committed Nov 20, 2024
    Configuration menu
    Copy the full SHA
    1c90428 View commit details
    Browse the repository at this point in the history

  4. Gracefully handle cases where __all__ is not set. 

    Return a non-zero exit value so that pre-commit will fail.
    @joaander
    joaander committed Nov 20, 2024
    Configuration menu
    Copy the full SHA
    7ac9868 View commit details
    Browse the repository at this point in the history

  5. Generate MD docs with generate-toctree.py.

    @joaander
    joaander committed Nov 20, 2024
    Configuration menu
    Copy the full SHA
    9a3e648 View commit details
    Browse the repository at this point in the history

  6. Setting the pattern to replicate inherited docs.

    @joaander
    joaander committed Nov 20, 2024
    Configuration menu
    Copy the full SHA
    26db137 View commit details
    Browse the repository at this point in the history

  7. Allow customization of autoclass files.

    @joaander
    joaander committed Nov 20, 2024
    Configuration menu
    Copy the full SHA
    833d9ee View commit details
    Browse the repository at this point in the history

  8. Add generated rst files.

    @joaander
    joaander committed Nov 20, 2024
    Configuration menu
    Copy the full SHA
    6e160ac View commit details
    Browse the repository at this point in the history

  9. Tweak docs up to hoomd.device.

    @joaander
    joaander committed Nov 20, 2024
    Configuration menu
    Copy the full SHA
    77fc444 View commit details
    Browse the repository at this point in the history

Commits on Nov 21, 2024

  1. Document inherited members in filter.

    @joaander
    joaander committed Nov 21, 2024
    Configuration menu
    Copy the full SHA
    c81175e View commit details
    Browse the repository at this point in the history

  2. Clean up logging documentation.

    @joaander
    joaander committed Nov 21, 2024
    Configuration menu
    Copy the full SHA
    db2df14 View commit details
    Browse the repository at this point in the history

  3. Clean up mesh documentation.

    @joaander
    joaander committed Nov 21, 2024
    Configuration menu
    Copy the full SHA
    264819c View commit details
    Browse the repository at this point in the history

  4. Changes missing from the previous few commits.

    @joaander
    joaander committed Nov 21, 2024
    Configuration menu
    Copy the full SHA
    b2f31aa View commit details
    Browse the repository at this point in the history

  5. Document inherited members in Trigger.

    @joaander
    joaander committed Nov 21, 2024
    Configuration menu
    Copy the full SHA
    a1771f2 View commit details
    Browse the repository at this point in the history

  6. Document inherited members in tune.

    @joaander
    joaander committed Nov 21, 2024
    Configuration menu
    Copy the full SHA
    556becd View commit details
    Browse the repository at this point in the history

  7. Document inherited members in update.

    @joaander
    joaander committed Nov 21, 2024
    Configuration menu
    Copy the full SHA
    7620b20 View commit details
    Browse the repository at this point in the history

  8. Document inherited members in variant.

    @joaander
    joaander committed Nov 21, 2024
    Configuration menu
    Copy the full SHA
    2737952 View commit details
    Browse the repository at this point in the history

Commits on Nov 22, 2024

  1. Document inherited methods in write.

    @joaander
    joaander committed Nov 22, 2024
    Configuration menu
    Copy the full SHA
    40e82b5 View commit details
    Browse the repository at this point in the history

Commits on Nov 25, 2024

  1. Document inherited members in most of HPMC.

    @joaander
    joaander committed Nov 25, 2024
    Configuration menu
    Copy the full SHA
    e339b78 View commit details
    Browse the repository at this point in the history

  2. Document inherited members in alchemy.

    @joaander
    joaander committed Nov 25, 2024
    Configuration menu
    Copy the full SHA
    e00acf2 View commit details
    Browse the repository at this point in the history

  3. Document inherited members for md modules up to force.

    @joaander
    joaander committed Nov 25, 2024
    Configuration menu
    Copy the full SHA
    791a923 View commit details
    Browse the repository at this point in the history

Commits on Nov 26, 2024

  1. Document inherited members in md.pair.

    @joaander
    joaander committed Nov 26, 2024
    Configuration menu
    Copy the full SHA
    8fae007 View commit details
    Browse the repository at this point in the history

  2. pre-commit

    @joaander
    joaander committed Nov 26, 2024
    Configuration menu
    Copy the full SHA
    1f4cb0c View commit details
    Browse the repository at this point in the history

  3. Automatically generate the sphinx toctree in pre-commit.

    @joaander
    joaander committed Nov 26, 2024
    Configuration menu
    Copy the full SHA
    2a07041 View commit details
    Browse the repository at this point in the history

  4. Fix syntax errors.

    @joaander
    joaander committed Nov 26, 2024
    Configuration menu
    Copy the full SHA
    9afcf02 View commit details
    Browse the repository at this point in the history

  5. List documentation updates.

    @joaander
    joaander committed Nov 26, 2024
    Configuration menu
    Copy the full SHA
    9c5aa8e View commit details
    Browse the repository at this point in the history

  6. Instruct developers how to document code.

    @joaander
    joaander committed Nov 26, 2024
    Configuration menu
    Copy the full SHA
    5ae6b2d View commit details
    Browse the repository at this point in the history

  7. Link to correct classes and members.

    @joaander
    joaander committed Nov 26, 2024
    Configuration menu
    Copy the full SHA
    1ba6c5c View commit details
    Browse the repository at this point in the history