diff --git a/.gitignore b/.gitignore index c1660ec..034004e 100644 --- a/.gitignore +++ b/.gitignore @@ -8,6 +8,7 @@ todo.taskpaper export.sql static/upload arnhem_data.sql +docs/ # Generated from gibo # Byte-compiled / optimized / DLL files diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index d0c3cbf..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# 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/make.bat b/docs/make.bat deleted file mode 100644 index 747ffb7..0000000 --- a/docs/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@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/source/architecture.rst b/docs/source/architecture.rst deleted file mode 100644 index cdb41a4..0000000 --- a/docs/source/architecture.rst +++ /dev/null @@ -1,13 +0,0 @@ -Architecture -============ - -.. toctree:: - :maxdepth: 2 - - -Overview --------- - -The Arnhem Postal History Project Django application has a single application: The :mod:`arnhem-app.postcards` application handles all related models, functionality, and views for viewing and interacting with postal material, people, and historical documents, while :class:`~arnhem-app.maps` handles the interface for the interactive map. - -More detailed `database documentation `_ is autogenerated and hosted via dbdocs.io. diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst deleted file mode 100644 index 6f90edd..0000000 --- a/docs/source/changelog.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../CHANGELOG.rst \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py deleted file mode 100644 index aed3a10..0000000 --- a/docs/source/conf.py +++ /dev/null @@ -1,81 +0,0 @@ -# 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 - -# -- Path setup -------------------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#path-setup -import os -import sys - -# import django - -sys.path.insert(0, os.path.abspath(".")) -os.environ["DJANGO_SETTINGS_MODULE"] = "config.settings" -# django.setup() - -# -- Project information ----------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information - -project = "Arnhem Postal History" -copyright = "2024, Roy Rosenzweig Center for History and New Media" -author = "The Roy Rosenzweig Center for History and New Media" -description = "Django web application for the Arnhem Postal History Project" - -# -- General configuration --------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration - -extensions = [ - "sphinx.ext.autodoc", - "sphinx.ext.doctest", - "sphinx.ext.viewcode", - "sphinx.ext.githubpages", -] - -templates_path = ["_templates"] -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] - - -# -- 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"] - -html_theme_options = { - "description": description, - "github_user": "chnm", - "github_repo": "arnhem-postal", - "codecov_button": True, -} - -# html_sidebars = { -# "**": [ -# "about.html", -# "navigation.html", -# "localtoc.html", -# "searchbox.html", -# "sidebar_footer.html", -# ], -# } - -# Configure for intersphinx for Python standard library, Django, -# and local dependencies with sphinx docs. -intersphinx_mapping = { - "https://docs.python.org/3/": None, - "django": ("https://django.readthedocs.org/en/latest/", None), - "viapy": ("https://viapy.readthedocs.io/en/latest/", None), -} - - -coverage_ignore_pyobjects = [ - # django auto-generated model methods - "clean_fields", - "get_deferred_fields", - "get_(next|previous)_by_(created|last_modified|modified)", - "refresh_from_db", - "get_.*_display", # django auto-generated method for choice fields - "get_doc_relation_list", # multiselectfield auto method -] - -# coverage_statistics_to_report = coverage_statistics_to_stdout = False diff --git a/docs/source/devnotes.rst b/docs/source/devnotes.rst deleted file mode 100644 index fa21f72..0000000 --- a/docs/source/devnotes.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../DEVNOTES.rst \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst deleted file mode 100644 index 7dd546f..0000000 --- a/docs/source/index.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. Arnhem Postal History documentation master file, created by - sphinx-quickstart on Tue Apr 16 11:09:32 2024. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to Arnhem Postal History's documentation! -================================================= - -.. toctree:: - :maxdepth: 1 - :caption: Contents: - - architecture - devnotes - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search`