diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..89a4e96 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,10 @@ +version: 2 +formats: all +python: + version: 3.9 + install: + - requirements: docs/requirements.txt +sphinx: + builder: html + configuration: docs/conf.py + fail_on_warning: true diff --git a/docs/conf.py b/docs/conf.py index 01c9eee..ee99377 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,30 +1,5 @@ -# Soapfish documentation build configuration file, created by -# sphinx-quickstart on Thu Mar 6 16:06:14 2014. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. extensions = [ - 'sphinx.ext.todo', + 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode', ] @@ -97,15 +72,11 @@ # If true, keep warnings as "system message" paragraphs in the built documents. # keep_warnings = False -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False - - # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'alabaster' +html_theme = 'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -134,7 +105,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = [] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..cbf1e36 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +sphinx +sphinx-rtd-theme diff --git a/setup.cfg b/setup.cfg index cfef47e..bbfc449 100644 --- a/setup.cfg +++ b/setup.cfg @@ -33,6 +33,9 @@ classifiers = Programming Language :: Python :: Implementation :: CPython Topic :: Internet :: WWW/HTTP Topic :: Software Development :: Libraries :: Python Modules +project_urls = + Documentation = https://soapfish.readthedocs.io/ + Source = https://github.com/soapteam/soapfish [options] zip_safe = false