astropy / astropy/sphinx-automodapi

Generating automodsumm for main package directory

Open
#74 0 comments 0 reactions 0 assignees View on GitHub
question
Dominant language
Python
Stars
67
Forks
48
Avg merge
11h 52m
Merged PRs (30d)
1

Description

I have developed a package which for the most part contains functions in different modules within the package. I am documenting these functions wonderfully using automodsumm. But the package also has some base functions which are available using package_name.function1, package_name.function2, etc. I would also like to add these to my documentation in the same format as automodsumm, but I have not been able to figure out how to reference the top level of the package to generate the proper documentation.

I tried (and all possible deviations there of):

```
.. automodsumm:: package_name
:toctree: my title
:functions-only:
```

But this leads to an issue with the import. How can I specify that it is supposed to document all the functions included in the package itself? I sadly couldn't find anything in the documentation about this.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the automodsumm directive and the package_name entry point shown in the issue, then inspect the extension's documented handling of package-level objects. Reproduce the import failure with a minimal package and verify the generated API documentation; done means top-level functions are listed in the same format without an import error.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.