Skip to content

Commit

Permalink
Fix docs (for real) and make Pipfile the single source of truth
Browse files Browse the repository at this point in the history
  • Loading branch information
ritikmishra committed Feb 26, 2024
1 parent f617087 commit 952c992
Show file tree
Hide file tree
Showing 5 changed files with 1,993 additions and 10 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@ personalscripts/**/*
out/
dist/
build/
Pipfile.lock
17 changes: 10 additions & 7 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,20 @@
# Required
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.10"
jobs:
pre_install:
- "pip install pipenv"
- "pipenv requirements --categories docs,default > requirements.txt"

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

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

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.8
install:
- requirements: docs/requirements.txt
- requirements: requirements.txt
3 changes: 3 additions & 0 deletions Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,11 @@ tox-pipenv = "*"
twine = "*"
pipenv-to-requirements = "*"
mypy = "*"

[docs]
sphinx = "==7.2.6"
furo = "==2024.1.29"

[requires]
python_version = "3.8"

Loading

0 comments on commit 952c992

Please sign in to comment.