averbraeck / djunits

Delft Java UNIT System for using strongly-typed quantities and units
BSD 3-Clause "New" or "Revised" License
1 stars 0 forks source link

Generation of readthedocs with mkdocs does not work anymore #22

Closed averbraeck closed 5 months ago

averbraeck commented 5 months ago

Compilation failure on readthedocs.io results in a failure.

averbraeck commented 5 months ago

For readthedocs, a new file called .readthedocs.yaml in the root directory of the project is needed, with the following content:

# Read the Docs configuration file for MkDocs projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
  os: ubuntu-22.04
  tools:
    python: "3.12"

mkdocs:
  configuration: mkdocs.yml

# Optionally declare the Python requirements required to build your docs
python:
  install:
  - requirements: docs/requirements.txt
averbraeck commented 5 months ago

The file requirements.txt has been moved to the docs folder to minimize the number of files in the root folder.

averbraeck commented 5 months ago

After this change, the documents on readthedocs are generated again.