Skip to content

Commit

Permalink
Bugfix/123 rtd (#124)
Browse files Browse the repository at this point in the history
* New rtd config. Refs #123

* Docs update. Refs #123
  • Loading branch information
koenedaele authored Oct 21, 2024
1 parent fda805f commit 752b67c
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 5 deletions.
35 changes: 35 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.12"
# You can also specify other tool versions:
# nodejs: "20"
# rust: "1.70"
# golang: "1.20"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
# builder: "dirhtml"
# Fail on all warnings to avoid broken references
# fail_on_warning: true

# Optionally build your docs in additional formats such as PDF and ePub
formats:
- pdf
- epub

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: requirements-dev.txt
10 changes: 5 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,16 @@

# General information about the project.
project = 'Skosprovider'
copyright = '2012-2021, Koen Van Daele'
copyright = '2012-2024, Koen Van Daele'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1.1'
version = '1.2'
# The full version, including alpha/beta/rc tags.
release = '1.1.1'
release = '1.2.1'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -90,7 +90,7 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'alabaster'
#html_theme = 'alabaster'

# 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
Expand Down Expand Up @@ -247,7 +247,7 @@
epub_title = 'Skosprovider'
epub_author = 'Koen Van Daele'
epub_publisher = 'Koen Van Daele'
epub_copyright = '2012-2021, Koen Van Daele'
epub_copyright = '2012-2024, Koen Van Daele'

# The language of the text. It defaults to the language option
# or en if the language is not set.
Expand Down

0 comments on commit 752b67c

Please sign in to comment.