Skip to content

Commit

Permalink
Move to new rtfd configuration format
Browse files Browse the repository at this point in the history
  • Loading branch information
pcisar committed Sep 26, 2023
1 parent 27e0f25 commit ddaa1ae
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 5 deletions.
17 changes: 17 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: sphinx/conf.py


# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.8
install:
- requirements: sphinx/requirements.txt
2 changes: 0 additions & 2 deletions requirements.txt

This file was deleted.

7 changes: 4 additions & 3 deletions sphinx/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

import sys, os
import sphinx_bootstrap_theme
from fdb import __version__

# If your extensions are in another directory, add it here. If the directory
# is relative to the documentation root, use os.path.abspath to make it
Expand Down Expand Up @@ -43,16 +44,16 @@

# General information about the project.
project = u'FDB'
copyright = u'2009-2021 Pavel Cisar'
copyright = u'2009-present Pavel Cisar'

# 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 = '2.0.2'
version = __version__
# The full version, including alpha/beta/rc tags.
release = '2.0.2'
release = __version__

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
4 changes: 4 additions & 0 deletions sphinx/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
sphinx-bootstrap-theme>=0.8.1
sphinx-autodoc-typehints>=1.24.0
sphinx>=5.3
.

0 comments on commit ddaa1ae

Please sign in to comment.