Skip to content

Revert "[doc] use sphinx-autoapi" #243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
#

# You can set these variables from the command line.
SPHINXAPIDOC = sphinx-apidoc
SPHINXOPTS = -c source
SPHINXBUILD = sphinx-build
SPHINXPROJ = kubernetes-client
Expand All @@ -16,7 +17,7 @@ help:

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).

html:
$(SPHINXAPIDOC) -o "$(SOURCEDIR)" ../kubernetes_asyncio/ -e -f
$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@echo "\nDocs rendered successfully, open _/build/html/index.html to view"
4 changes: 0 additions & 4 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,11 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'autoapi.extension',
'sphinx.ext.autodoc',
# 'myst_parser',
# 'sphinx.ext.intersphinx',
]

autoapi_type = 'python'
autoapi_dirs = ['../../kubernetes_asyncio/']


# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
Expand Down
1 change: 0 additions & 1 deletion test-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,3 @@ pytest-xdist
randomize>=0.13
recommonmark
sphinx>=1.2.1,!=1.3b1,<6.2 # BSD
sphinx-autoapi