Skip to content

Commit

Permalink
Merge branch 'read_the_docs' into temp
Browse files Browse the repository at this point in the history
  • Loading branch information
M0stafaRady authored Dec 31, 2023
2 parents 3841069 + bbef2b3 commit 11f31bd
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 1 deletion.
35 changes: 35 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# 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: cocotb/caravel_cocotb/docs/source/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: cocotb/caravel_cocotb/docs/source/requirements.txt
3 changes: 2 additions & 1 deletion cocotb/caravel_cocotb/docs/source/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ docker
cocotb
oyaml
breathe
cocotb_coverage
cocotb_coverage
sphinx_rtd_theme
1 change: 1 addition & 0 deletions cocotb/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@ anytree
PyYAML
tabulate
rich
breathe

0 comments on commit 11f31bd

Please sign in to comment.