sphinx-simplepdf icon indicating copy to clipboard operation
sphinx-simplepdf copied to clipboard

Unable to customize the build in `.readthedocs.yaml`

Open sachin-suresh-rapyuta opened this issue 2 years ago • 1 comments

I am trying to configure ReadtheDocs to use simplepdf extension as described in your documentation.

  • I am using version 2 of the .readthedocs.yaml file. But using build.commands does not seem to work. (Error: Property commands is not allowed)

As a workaround, I am trying with builds.jobs.post_build option. Even this seems to fail on ReadtheDocs during the build.

.readthedocs.yaml

# Required
version: 2

#submodules:
#  include:
#    - paamr-deployment

# Set the version of Python and other tools you might need
build:
  os: ubuntu-20.04
  tools:
    python: "3.9"
    # You can also specify other tool versions:
    # nodejs: "16"
    # rust: "1.55"
    # golang: "1.17"
  jobs:
    post_build:
      - cd docs && python -m sphinx-build -a -E -b simplepdf docs build/simplepdf/en/

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

# If using Sphinx, optionally build your docs in additional formats such as PDF
formats: all

# Optionally declare the Python requirements required to build your docs
python:
  install:
    - requirements: docs/requirements.txt

Here is the error trace:

Running Sphinx v5.1.1

/bin/sh: 1: sphinx-build: not found

Can you please help with the right set of configuration options that needs to be written in .readthedocs.yaml file.

sachin-suresh-rapyuta avatar Oct 31 '22 05:10 sachin-suresh-rapyuta