Skip to content

Commit

Permalink
Add the .readthedocs.yaml configuration file
Browse files Browse the repository at this point in the history
Signed-off-by: tdruez <[email protected]>
  • Loading branch information
tdruez committed Dec 7, 2023
1 parent f74752c commit 78070f0
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
28 changes: 28 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Read the Docs configuration file
# 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.10"

# Optionally declare the Python requirements required to build your docs
python:
install:
- method: pip
path: .
extra_requirements:
- dev

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

# Optionally build your docs in additional formats such as PDF and ePub
formats:
- pdf
- epub
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ the industry-leading code scanner.
Getting started
---------------

The DejaCode documentation is available here: https://dejacode.readthedocs.org/
The DejaCode documentation is available here: https://dejacode.readthedocs.io/

If you have questions please ask them in
`Discussions <https://github.com/nexB/dejacode/discussions>`_.
Expand Down

0 comments on commit 78070f0

Please sign in to comment.