Skip to content

Commit

Permalink
[+] add .readthedocs.yaml configuration file v2 (#608)
Browse files Browse the repository at this point in the history
[+] add `.readthedocs.yaml` configuration file v2
  • Loading branch information
pashagolub authored Oct 11, 2023
1 parent 03aed87 commit 4cbc84e
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 6 deletions.
19 changes: 19 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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
7 changes: 1 addition & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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',
Expand Down
2 changes: 2 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Sphinx
sphinx_rtd_theme

0 comments on commit 4cbc84e

Please sign in to comment.