Skip to content

DOC: Add _config.yml example for sphinx-autodoc2 - #1225

Open
zheng-guannan577 wants to merge 1 commit into
executablebooks:masterfrom
zheng-guannan577:docs-933-autodoc2-config
Open

zheng-guannan577 wants to merge 1 commit into
executablebooks:masterfrom
zheng-guannan577:docs-933-autodoc2-config

Conversation

@zheng-guannan577

Copy link
Copy Markdown

Closes #933.

Adds a Jupyter Book _config.yml example to the sphinx-autodoc2 section of docs/syntax/code_and_apis.md (install, extra_extensions, autodoc2_packages / render plugin / docstring parser regexes, and the _toc.yml entry).

Verified locally: the example YAML parses, sphinx-build -nW exits 0 and the new section renders.

Added configuration instructions for Jupyter Book using sphinx-autodoc2 in the documentation.

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add example config.yml entries for autodoc-2

1 participant