Skip to content

More Complete Info about Auto Documentation #934

Open

Description

@s2t2

The docs mention using either autodoc or autodoc2 to automatically generate documentation.

However the information provided is insufficient to reproduce.

Let's consider adding much more details to this page sufficient to help someone get it working, and/or add some references to a few working examples.

Activity

  1. i2000s commented on May 30, 2024

    @i2000s

    In sphinx, we usually add a few lines to let the program know where to look up for autodoc sources. For instance, these

    sys.path.insert(0, os.path.abspath(os.path.join('src')))
    sys.path.insert(0, os.path.abspath(os.path.join('.')))
    sys.path.insert(0, os.path.abspath(os.path.join('modules', 'my_module', 'src')))
    

    But there doesn't seem to have a proper place to put these lines in Jupyter Book. Could MYSt-Parser to implement some machenism to recognize such settings in a markdown environment?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions