Implement docs (PRAW copy)

Author: PythonCoderAS

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     = .
+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)

docs/_static/theme_override.css

@@ -0,0 +1,18 @@
+/* Table text wrapping CSS fix from
+https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html */
+
+/* override table width restrictions */
+@media screen and (min-width: 767px) {
+
+   .wy-table-responsive table td {
+      /* !important prevents the common CSS stylesheets from overriding
+         this as on RTD they are loaded after this stylesheet */
+      white-space: normal !important;
+   }
+
+   .wy-table-responsive {
+      overflow: visible !important;
+   }
+}
+
+table.center-table-items, table.center-table-items th { text-align: center; }

docs/conf.py

@@ -0,0 +1,51 @@
+import os
+import sys
+
+# Do not touch these. They allow the use of the local PRAWdittions.
+sys.path.insert(0, ".")
+sys.path.insert(1, "..")
+
+from prawdditions import __version__
+
+
+copyright = "2020, PokestarFan"
+exclude_patterns = ["_build"]
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx"]
+html_static_path = ["_static"]
+html_theme = "sphinx_rtd_theme"
+html_theme_options = {"collapse_navigation": True}
+htmlhelp_basename = "PRAWdittions"
+intersphinx_mapping = {"python": ("https://docs.python.org/3.8", None)}
+master_doc = "index"
+nitpicky = True
+project = "PRAWdittions"
+pygments_style = "sphinx"
+release = __version__
+source_suffix = ".rst"
+suppress_warnings = ["image.nonlocal_uri"]
+version = ".".join(__version__.split(".", 2)[:2])
+
+
+# Use RTD theme locally
+if not os.environ.get("READTHEDOCS"):
+    import sphinx_rtd_theme
+
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+
+def skip(app, what, name, obj, skip, options):
+    if name in {
+        "__call__",
+        "__contains__",
+        "__getitem__",
+        "__init__",
+        "__iter__",
+        "__len__",
+    }:
+        return False
+    return skip
+
+
+def setup(app):
+    app.connect("autodoc-skip-member", skip)
+    app.add_stylesheet("theme_override.css")

docs/docutils.conf

@@ -0,0 +1,2 @@
+[parsers]
+smart_quotes: true

docs/generate_local_docs.bat

@@ -0,0 +1,2 @@
+RMDIR /s /q _build
+make html

docs/index.rst

@@ -0,0 +1,19 @@
+
+
+PRAWdittions
+============
+
+PRAWdittions is a high-end library wrapper for PRAW that provides several
+functions that are missing from the main package. The only dependency is PRAW.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+References
+==========
+
+* :ref:`genindex`
+* :ref:`search`

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=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%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.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

pre_push.py

@@ -4,7 +4,9 @@
 import argparse
 import sys
 from os import path
+from shutil import rmtree
 from subprocess import CalledProcessError, check_call
+from tempfile import mkdtemp
 
 current_directory = path.abspath(path.join(__file__, ".."))
 
@@ -40,6 +42,13 @@ def run_static():
     success &= do_process(["black", "."])
     success &= do_process(["flake8", "--exclude=.eggs,build,docs"])
     success &= do_process(["pydocstyle", "prawdditions"])
+    tmp_dir = mkdtemp()
+    try:
+        success &= do_process(
+            ["sphinx-build", "-W", "--keep-going", "docs", tmp_dir]
+        )
+    finally:
+        rmtree(tmp_dir)
     return success