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

Initial commit of documentation System #66

Merged
merged 5 commits into from
Nov 13, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# ignore files created during build
build/
src/cocotb_bus.egg-info/
*.vcd
*.xml
sim_build
34 changes: 34 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# .readthedocs.yaml
# Read the Docs configuration file
# 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: "19"
# rust: "1.64"
# golang: "1.19"

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

# 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
- method: pip
path: .
16 changes: 16 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Python dependencies to build the documentation

Sphinx ~= 7.0
breathe
jahagirdar marked this conversation as resolved.
Show resolved Hide resolved
sphinx-rtd-theme >= 1.3.0
sphinxcontrib-svg2pdfconverter[CairoSVG]
sphinxcontrib-makedomain
jahagirdar marked this conversation as resolved.
Show resolved Hide resolved
sphinxcontrib-spelling >= 5.3.0
pyenchant
sphinx-issues
sphinx-argparse-cli
towncrier
IPython
jahagirdar marked this conversation as resolved.
Show resolved Hide resolved
sphinx-tabs
sphinxcontrib-details-directive
looseversion
Loading