Skip to content

Commit

Permalink
Update readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
perdelt committed Sep 10, 2023
1 parent 33a7eab commit b7e4e27
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 5 deletions.
26 changes: 26 additions & 0 deletions .readthedocs.yaml
@@ -0,0 +1,26 @@
# .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/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
python:
install:
- requirements: requirements.txt
- requirements: docs/requirements.txt
15 changes: 12 additions & 3 deletions docs/conf.py
Expand Up @@ -6,8 +6,8 @@
copyright = '2021, Patrick Erdelt'
author = 'Patrick Erdelt'

release = '0.1'
version = '0.1.0'
release = '0.13.2'
version = '0.13.2'

# -- General configuration

Expand All @@ -17,10 +17,12 @@
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.intersphinx',
'sphinx_mdinclude',
#'myst_parser',
'm2r2',
#'m2r2',
]


intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None),
'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
Expand All @@ -38,3 +40,10 @@
epub_show_urls = 'footnote'

#source_suffix = ['.rst', '.md']

todo_include_todos = True

import os
import sys
#sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('../'))
3 changes: 3 additions & 0 deletions docs/requirements.txt
@@ -0,0 +1,3 @@
sphinx
sphinx-rtd-theme
sphinx-mdinclude
4 changes: 2 additions & 2 deletions requirements.txt
Expand Up @@ -37,6 +37,6 @@ six>=1.14.0
urllib3==1.26.5
uuid>=1.30
Werkzeug>=2.2.3
m2r2
myst_parser
#m2r2
#myst_parser
mistune>=2.0.3 # not directly required, pinned by Snyk to avoid a vulnerability

0 comments on commit b7e4e27

Please sign in to comment.