still testing docs

Author: mahtin

Makefile

@@ -103,11 +103,11 @@ sign:
 	ls -l tarball/$$v.tar.gz.asc tarball/$$v.zip.asc ;
 
 docs: all
-	sphinx-apidoc -Mfe -o docs . setup.py
-	sphinx-build -j auto -b html docs docs/_build/html
+	sphinx-apidoc --force --module-first --separate --full --ext-autodoc -A 'Martin J Levy' -R 2.20.0 -V 2.20.0 -o docs . 'setup.py'
+	sphinx-build -a -E -j auto -b html docs docs/_build/html
 
 clean-docs: all
-	rm -rf docs/*.rst docs/_build/
+	rm -rf docs/CloudFlare*.rst docs/cli4*.rst docs/examples*.rst docs/modules*.rst docs/_build docs/_static
 
 lint:
 	$(PYLINT) CloudFlare cli4

docs/Makefile

@@ -1,4 +1,3 @@
-#
 # Minimal makefile for Sphinx documentation
 #
 
@@ -8,7 +7,6 @@ SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build
-STATICDIR     = _static
 
 # Put it first so that "make" without argument is like "make help".
 help:
@@ -19,5 +17,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	mkdir -p ${BUILDDIR} ${STATICDIR}
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -6,44 +6,35 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-import re
-with open('../CloudFlare/__init__.py', 'r') as f:
-    _version_re = re.compile(r"__version__\s=\s'(.*)'")
-    version = _version_re.search(f.read()).group(1)
-
 project = 'python-cloudflare'
-copyright = 'Copyright (c) 2016 thru 2024, Cloudflare. All rights reserved.'
+copyright = '2024, Martin J Levy'
 author = 'Martin J Levy'
-release = str(version)
+
+version = '2.20.0'
+release = '2.20.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
-    'myst_parser',
     'sphinx.ext.autodoc',
-    'sphinx_rtd_theme',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.todo',
+    'sphinx.ext.autodoc',
 ]
 
-html_theme = "sphinx_rtd_theme"
-
 templates_path = ['_templates']
-exclude_patterns = [
-    'CloudFlare/__init__.py',
-    'CloudFlare/tests/__init__.py',
-    '_build',
-    'Thumbs.db',
-    '.DS_Store'
-]
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-autoclass_content = 'both'
+language = 'en'
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = 'alabaster'
 html_static_path = ['_static']
 
-import os
-import sys
-sys.path.insert(0, os.path.abspath('..'))
+# -- Options for todo extension ----------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration
+
+todo_include_todos = True

docs/index.rst

@@ -1,27 +1,20 @@
 .. python-cloudflare documentation master file, created by
-   sphinx-quickstart on Fri Mar  1 09:53:57 2024.
+   sphinx-quickstart on Sun Mar  3 23:59:20 2024.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
 Welcome to python-cloudflare's documentation!
 =============================================
 
-This `python-cloudflare` package is a Python wrapper providing full access to the CloudFlare v4 API.
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-python-cloudflare
-=================
-
 .. toctree::
    :maxdepth: 4
+   :caption: Contents:
 
    CloudFlare
    cli4
    examples
 
+
 Indices and tables
 ==================