Skip to content

Commit

Permalink
Upgrade to new Read the Docs config
Browse files Browse the repository at this point in the history
  • Loading branch information
stanislaw committed Nov 26, 2023
1 parent f18bff9 commit 10f7429
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 6 deletions.
10 changes: 7 additions & 3 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,14 @@ sphinx:
# Optionally build your docs in additional formats such as PDF and ePub
formats:
- pdf
# - epub

build:
os: ubuntu-22.04
tools:
python: "3.8"

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.5
install:
- requirements: docs/requirements.txt

- requirements: requirements.dev.txt
20 changes: 17 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
import os
import sys

# -- Path setup --------------------------------------------------------------

Expand All @@ -16,14 +18,28 @@

import guzzle_sphinx_theme

try:
filecheck_root_path = os.path.abspath(
os.path.join(os.path.dirname(__file__), "..")
)
if not os.path.isdir(filecheck_root_path):
raise FileNotFoundError
sys.path.append(filecheck_root_path)
from filecheck.filecheck import __version__ as filecheck_version
except Exception as exception:
print( # noqa: T201
f"Could not resolve a path to filecheck's root: {exception}"
)
sys.exit(1)

# -- Project information -----------------------------------------------------

project = "FileCheck.py"
copyright = "2019-2023, Stanislav Pankevich"
author = "Stanislav Pankevich"

# The full version, including alpha/beta/rc tags
release = "0.0.1"
release = filecheck_version


# -- General configuration ---------------------------------------------------
Expand Down Expand Up @@ -51,8 +67,6 @@
extensions.append("guzzle_sphinx_theme")
html_theme = "guzzle_sphinx_theme"

# html_theme = 'pyramid'

html_theme_options = {
"project_nav_name": "Mull",
}
Expand Down
3 changes: 3 additions & 0 deletions requirements.dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,6 @@ flake8>=3.9.2
coverage>=5.4
pytest>=6.2.2
lit>=0.9

# Docs
guzzle_sphinx_theme

0 comments on commit 10f7429

Please sign in to comment.