diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml index bdea5e1..217f817 100644 --- a/.github/workflows/python-package.yml +++ b/.github/workflows/python-package.yml @@ -24,6 +24,7 @@ jobs: python -m pip install --upgrade pip python -m pip install flake8 pytest pytest-cov if [ -f requirements.txt ]; then pip install -r requirements.txt; fi + python -m pip install -e . - name: Lint with flake8 run: | # stop the build if there are Python syntax errors or undefined names diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..863de73 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,22 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/source/conf.py + +# We recommend specifying your dependencies to enable reproducible builds: +# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: docs/requirements.txt \ No newline at end of file diff --git a/requirements.txt b/docs/requirements.txt similarity index 56% rename from requirements.txt rename to docs/requirements.txt index 06ac856..c7e1408 100644 --- a/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,4 @@ +sphinx>=3.0 +sphinx-rtd-theme requests>=2.0.0,<3.0.0 beautifulsoup4 diff --git a/docs/source/_static/custom.css b/docs/source/_static/custom.css new file mode 100644 index 0000000..1059090 --- /dev/null +++ b/docs/source/_static/custom.css @@ -0,0 +1,4 @@ +/* Set the properties to be full width */ +dl.py.property { + display: block !important; +} \ No newline at end of file diff --git a/docs/source/_themes/custom_theme/__init__.py b/docs/source/_themes/custom_theme/__init__.py deleted file mode 100644 index 67387b7..0000000 --- a/docs/source/_themes/custom_theme/__init__.py +++ /dev/null @@ -1,19 +0,0 @@ -"""Sphinx ReadTheDocs theme. - -From https://github.com/ryan-roemer/sphinx-bootstrap-theme. - -""" -from os import path - -__version__ = '0.4.1' -__version_full__ = __version__ - - -def get_html_theme_path(): - """Return list of HTML theme paths.""" - cur_dir = path.abspath(path.dirname(path.dirname(__file__))) - return cur_dir - -# See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package -def setup(app): - app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__))) diff --git a/docs/source/_themes/custom_theme/breadcrumbs.html b/docs/source/_themes/custom_theme/breadcrumbs.html deleted file mode 100644 index 31550d8..0000000 --- a/docs/source/_themes/custom_theme/breadcrumbs.html +++ /dev/null @@ -1,82 +0,0 @@ -{# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #} - -{% if page_source_suffix %} -{% set suffix = page_source_suffix %} -{% else %} -{% set suffix = source_suffix %} -{% endif %} - -{% if meta is defined and meta is not none %} -{% set check_meta = True %} -{% else %} -{% set check_meta = False %} -{% endif %} - -{% if check_meta and 'github_url' in meta %} -{% set display_github = True %} -{% endif %} - -{% if check_meta and 'bitbucket_url' in meta %} -{% set display_bitbucket = True %} -{% endif %} - -{% if check_meta and 'gitlab_url' in meta %} -{% set display_gitlab = True %} -{% endif %} - -
diff --git a/docs/source/_themes/custom_theme/footer.html b/docs/source/_themes/custom_theme/footer.html deleted file mode 100644 index 448d145..0000000 --- a/docs/source/_themes/custom_theme/footer.html +++ /dev/null @@ -1,52 +0,0 @@ - - diff --git a/docs/source/_themes/custom_theme/layout.html b/docs/source/_themes/custom_theme/layout.html deleted file mode 100644 index 82950a2..0000000 --- a/docs/source/_themes/custom_theme/layout.html +++ /dev/null @@ -1,219 +0,0 @@ -{# TEMPLATE VAR SETTINGS #} -{%- set url_root = pathto('', 1) %} -{%- if url_root == '#' %}{% set url_root = '' %}{% endif %} -{%- if not embedded and docstitle %} - {%- set titlesuffix = " — "|safe + docstitle|e %} -{%- else %} - {%- set titlesuffix = "" %} -{%- endif %} -{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) %} - - - - - - - {{ metatags }} - - {% block htmltitle %} -{{ _('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.') }}
- {% endif %} - {% endif %} -{{ context|e }}
-