sphinx-automodapi
sphinx-automodapi copied to clipboard
astropy
Sphinx extension for generating API documentation
If this is to be used beyond Astropy, and given that graphviz is not always installed, I wonder if it would make sense to make the inheritance diagrams opt-in?
We should add more test cases (similar to those added in https://github.com/astropy/sphinx-automodapi/pull/3) that test the following options: * ``:allowed-package-names:`` * ``:inherited-members:`` * ``:no-inherited-members:`` This will increase the test coverage further....
In addition to #13, it would be good to do some profiling to see if there are any easy optimizations, since generating the API docs for a project like Astropy...
When running a documentation build multiple times, even if all the rest is cache, the full API docs get re-generated. We should have a way to cache this, though I...
Almost all the tests fail inside a sandboxed build environment because they require network access for some reason. The error is always the same: ``` python3.10-sphinx-automodapi> Warning, treated as error:...
Consider the following source `bar.py`: ``` import typing class Bar: def type_info(): return None ROW_ANNOTATION = typing.Tuple[ str] ``` `conf.py`: ``` extensions = [ 'sphinx_automodapi.automodapi', ] ``` `index.rst`: ``` .....
Hi, Really sorry for disturbing you, but I am running into a very curious issue when trying to create a mamba environment where sphinx-automodapi is installed. Even more curious because...
Hello. I'm new to automodapi and i tried to do use your library for my python code: """ .. automodapi:: path.to.my.code.with.a.long.name.mycode :inheritance-diagram: .. automodapi:: path.to.my.code.with.a.long.name.mysecondcode :inheritance-diagram: """ However my path...
@bsipocz reported this in #179. Apparently it is flaky.
