Skip to content

Documentation for how to use audodoc is missing important parts #9

@smileservices

Description

@smileservices

For someone new to sphinx going through the simple setup is quite difficult and confusing to figure out how to use autodoc:

  • what is autodoc? an extension? a module? a command?
  • how to install the autodoc?
  • how to set the source code path with sys.path.insert(0, os.path.abspath('.')) ?
  • a working example of setting up autodoc complete with everything, not just incomplete bits and pieces

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions