Skip to content

Commit

Permalink
Initial commit of documentation System (#66)
Browse files Browse the repository at this point in the history
Add documentation and its build environment.
  • Loading branch information
jahagirdar authored Nov 13, 2023
1 parent 2c846dc commit 715d585
Show file tree
Hide file tree
Showing 12 changed files with 1,209 additions and 0 deletions.
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: .
13 changes: 13 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Python dependencies to build the documentation

Sphinx ~= 7.0
sphinx-rtd-theme >= 1.3.0
sphinxcontrib-svg2pdfconverter[CairoSVG]
sphinxcontrib-spelling >= 5.3.0
pyenchant
sphinx-issues
sphinx-argparse-cli
towncrier
sphinx-tabs
sphinxcontrib-details-directive
looseversion
118 changes: 118 additions & 0 deletions docs/source/_static/cocotb-logo-white.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 715d585

Please sign in to comment.