astropy / astropy/sphinx-automodapi
Does work under .. only:: html
- Dominant language
- Python
- Stars
- 67
- Forks
- 48
- Avg merge
- 11h 52m
- Merged PRs (30d)
- 1
Description
When I tried to use it under `..only:: html`, I got a warning and nothing was generated.
Code :
```
.. only:: html
.. automodule:: mymodule
:members:
:undoc-members:
.. automodapi:: mymodule
:inheritance-diagram:
:include-all-objects:
:no-heading:
:no-main-docstr:
```
Warning:
```
WARNING: Unknown directive type "automodapi"
```
Sphinx version: 1.8.5
Contributor guide
No contributing guide indexed for this repository
Research direction
Reproduce the warning with the provided Sphinx 1.8.5 example, placing the automodapi directive inside `.. only:: html`. Then inspect how the extension registers directives and verify that the example generates API documentation without an unknown-directive warning.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100