Skip to content

Commit

Permalink
chore: rtfd configurations
Browse files Browse the repository at this point in the history 
Signed-off-by: Frost Ming <[email protected]>
  • Loading branch information
@frostming
frostming committed Jan 15, 2024
1 parent 80ba38c commit 49dea44
Show file tree
Hide file tree
Showing 4 changed files with 369 additions and 11 deletions.
19 changes: 19 additions & 0 deletions .readthedocs.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Read the Docs configuration file for Sphinx projects
# 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.11"
commands:
- pip install -U pdm
- pdm install -Gdoc --no-editable
- pdm run doc $READTHEDOCS_OUTPUT/html

# Build documentation in the "docs/" directory with Sphinx
sphinx:

This comment has been minimized.

Sign in to view

Copy link
@humitos

humitos Jan 16, 2024

Note that sphinx key is ignored when using build.commands. So, you can remove it completely 👍🏼 . Ideally, Read the Docs will show a notification on the build details' page about these ignored keys.
configuration: docs/conf.py
7 changes: 0 additions & 7 deletions docs/requirements.txt
View file

This file was deleted.

Loading

2 comments on commit 49dea44

@astrojuanlu
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @humitos another nice example of build.commands

(also interesting that people still refer to Read the Docs as rtfd 😄)

@frostming
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(also interesting that people still refer to Read the Docs as rtfd 😄)

Oh, isn't it the case now? rtfd.io is still an official short domain of it.

Please sign in to comment.