Skip to content

Commit

Permalink
docs(rtd): correct the configuration for ReadTheDocs (#1833)
Browse files Browse the repository at this point in the history
(cherry picked from commit 968f67b)
  • Loading branch information
laurent-laporte-pro committed Nov 24, 2023
1 parent 45fd500 commit 30fa9c7
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 8 deletions.
11 changes: 11 additions & 0 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,17 @@ v2.15.6 (2023-11-24)
* **variant:** correct slow variant study snapshot generation [`#1828`](https://github.com/AntaresSimulatorTeam/AntaREST/pull/1828)


### Documentation

* **RTD:** correct the configuration for [ReadTheDocs](https://antares-web.readthedocs.io/en/latest/) [`#1833`](https://github.com/AntaresSimulatorTeam/AntaREST/pull/1833)


### Contributors

<a href="https://github.com/laurent-laporte-pro">laurent-laporte-pro</a>.



v2.15.5 (2023-11-16)
--------------------

Expand Down
18 changes: 14 additions & 4 deletions readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,19 @@
# Read the Docs configuration file for MkDocs projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

python:
version: 3.8
install:
- requirements: requirements-doc.txt
# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: '3.8'

mkdocs:
configuration: mkdocs.yml

# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: requirements-doc.txt
4 changes: 0 additions & 4 deletions requirements-doc.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,2 @@
mkdocs
mkdocs-material

# Add the required dependencies for ReadTheDocs
sphinx
myst-parser

0 comments on commit 30fa9c7

Please sign in to comment.