diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..bb42c60 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,19 @@ +# 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 we might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +python: + install: + - requirements: docs/requirements.txt \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index b55b8e5..be6f1cb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -8,14 +8,9 @@ from datetime import datetime -from recommonmark.parser import CommonMarkParser - extensions = [] templates_path = ['templates', '_templates', '.templates'] source_suffix = ['.rst', '.md'] -source_parsers = { - '.md': CommonMarkParser, - } project = u'pg_timetable' copyright = str(datetime.now().year) @@ -25,7 +20,7 @@ exclude_patterns = ['_build'] pygments_style = 'sphinx' htmlhelp_basename = 'pg-timetable' -html_theme = 'sphinx_rtd_theme' +html_theme = "sphinx_rtd_theme" file_insertion_enabled = False latex_documents = [ ('index', 'pg-timetable.tex', u'pg_timetable Documentation', diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..b617ee0 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +Sphinx +sphinx_rtd_theme \ No newline at end of file