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

Unable to customize the build in .readthedocs.yaml #57

Open
sachin-suresh-rapyuta opened this issue Oct 31, 2022 · 1 comment
Open

Unable to customize the build in .readthedocs.yaml #57

sachin-suresh-rapyuta opened this issue Oct 31, 2022 · 1 comment

Comments

@sachin-suresh-rapyuta
Copy link

sachin-suresh-rapyuta commented Oct 31, 2022

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 sachin-suresh-rapyuta changed the title Unable to extend the build to use this extension's PDF Unable to customize the build in .readthedocs.yaml Nov 1, 2022
@sachin-suresh-rapyuta
Copy link
Author

I also tried to use the same format as mentioned in the documentation:

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

# 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"
  commands:
    - sphinx-build -b simplepdf docs docs/build/simplepdf

# 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

I still get the same error.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant