Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readthedocs docs outdated/ no long build. #198

Closed
HinTak opened this issue Aug 31, 2024 · 1 comment
Closed

Readthedocs docs outdated/ no long build. #198

HinTak opened this issue Aug 31, 2024 · 1 comment
Labels
good first issue good for first-time contributors

Comments

@HinTak
Copy link
Collaborator

HinTak commented Aug 31, 2024

Split off from
#152 (comment)

@HinTak HinTak added the good first issue good for first-time contributors label Aug 31, 2024
@rougier
Copy link
Owner

rougier commented Sep 2, 2024

From https://docs.readthedocs.io/en/stable/config-file/v2.html:

# 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.12"
    # You can also specify other tool versions:
    # nodejs: "20"
    # rust: "1.70"
    # golang: "1.20"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
  configuration: docs/conf.py
  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
  # builder: "dirhtml"
  # Fail on all warnings to avoid broken references
  # fail_on_warning: true

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

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
#   install:
#     - requirements: docs/requirements.txt

@HinTak HinTak closed this as completed in 3e8cebe Sep 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue good for first-time contributors
Projects
None yet
Development

No branches or pull requests

2 participants