docs(structure): Update to standard Sphinx #63

Change the docs structure using sphinx-quickstart to make the docs layout the same as ll my other projects. KISS closes #63
imAsparky · May 8, 2023 · f03086a · f03086a
1 parent 94e4374
commit f03086a
Show file tree

Hide file tree

Showing 18 changed files with 143 additions and 26 deletions.
diff --git a/CHANGELOG.rst → _OLD_CHANGELOG.rst b/CHANGELOG.rst → _OLD_CHANGELOG.rst
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/changelog.rst b/docs/changelog.rst
diff --git a/docs/conf.py b/docs/conf.py
diff --git a/docs/contributing.rst b/docs/contributing.rst
diff --git a/docs/make.bat b/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/docs/admin.rst → docs/source/admin.rst b/docs/admin.rst → docs/source/admin.rst
diff --git a/docs/api.rst → docs/source/api.rst b/docs/api.rst → docs/source/api.rst
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -0,0 +1 @@
+.. include:: ../../CHANGELOG.md
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -0,0 +1,74 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "django-tag-fields"
+copyright = '2023, "Alex Gaynor, Mark Sevelj and individual contributors."'
+author = '"Alex Gaynor, Mark Sevelj and individual contributors."'
+
+__version__ = "4.0.2"
+# The full version, including alpha/beta/rc tags.
+release = __version__
+
+
+master_doc = "index"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.intersphinx",
+    "myst_parser",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx_copybutton",
+    "sphinx_inline_tabs",
+    "sphinx.ext.todo",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "build", "Thumbs.db", ".DS_Store"]
+
+intersphinx_mapping = {
+    "django": (
+        "https://docs.djangoproject.com/en/stable",
+        "https://docs.djangoproject.com/en/stable/_objects/",
+    ),
+    "python": ("https://docs.python.org/3", None),
+}
+
+pygments_style = "monokai"
+pygments_dark_style = "monokai"
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "furo"
+html_static_path = ["_static"]
+
+# sphinx-copybutton is a lightweight code-block copy button
+# config options are here https://sphinx-copybutton.readthedocs.io/en/latest/
+# This config removes Python Repl + continuation, Bash line prefixes,
+# ipython and qtconsole + continuation, jupyter-console + continuation and preceding line numbers
+copybutton_prompt_text = (
+    r"^\d{1,4}|^.\d{1,4}|>>> |\s{2,6}|\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}:"
+)
+
+copybutton_prompt_is_regexp = True
+
+# datalad download-url http://www.tldp.org/LDP/Bash-Beginners-Guide/Bash-Beginners-Guide.pdf \
+# --dataset . \
+# -m "add beginners guide on bash" \
+# -O books/bash_guide.pdf
+# is correctly pasted with the following setting
+copybutton_line_continuation_character = "\\"
diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
@@ -0,0 +1,3 @@
+
+
+.. include:: ../../CONTRIBUTING.rst
diff --git a/docs/custom_tagging.rst → docs/source/custom_tagging.rst b/docs/custom_tagging.rst → docs/source/custom_tagging.rst
diff --git a/docs/external_apps.rst → docs/source/external_apps.rst b/docs/external_apps.rst → docs/source/external_apps.rst
diff --git a/docs/faq.rst → docs/source/faq.rst b/docs/faq.rst → docs/source/faq.rst
@@ -5,12 +5,7 @@ Frequently Asked Questions
 -----------------------------
 
 To start using tags, you can access the pre-built ``Tag`` model
-in ``tag_fields.models``.
-
-However, if you have a custom model derived
-from ``ThroughTableBase``you will need to query that instead.
-
-For the standard setup, use ``Tag.objects.all()`` to retrieve all the
+in ``tag_fields.models``.  However, if you have a custom model derived from ``ThroughTableBase``you will need to query that instead.  For the standard setup, use ``Tag.objects.all()`` to retrieve all the
 available tags.
 
 

diff --git a/docs/forms.rst → docs/source/forms.rst b/docs/forms.rst → docs/source/forms.rst
diff --git a/docs/getting_started.rst → docs/source/getting_started.rst b/docs/getting_started.rst → docs/source/getting_started.rst
diff --git a/docs/index.rst → docs/source/index.rst b/docs/index.rst → docs/source/index.rst
@@ -1,3 +1,8 @@
+.. django-tag-fields documentation master file, created by
+   sphinx-quickstart on Mon May  8 08:43:15 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
 Welcome to django-tag-fields's documentation!
 =============================================
 
@@ -12,8 +17,10 @@ tagging to your project easy and fun.
 
 ``django-tag-fields`` works with Django 3.2+ and Python 3.6+.
 
+
 .. toctree::
    :maxdepth: 2
+   :caption: Contents:
 
    getting_started
    forms
@@ -26,6 +33,8 @@ tagging to your project easy and fun.
    external_apps
    changelog
 
+
+
 Indices and tables
 ==================
 

diff --git a/docs/serializers.rst → docs/source/serializers.rst b/docs/serializers.rst → docs/source/serializers.rst