chipsalliance / chipsalliance/UHDM

Add Sphinx document generation and publish to readthedocs.io

Open
#40 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
269
Forks
48
Avg merge
2h 22m
Merged PRs (30d)
16

Description

* https://www.sphinx-doc.org/en/master/
* You probably want to use exhale which allows you to do Doxygen - https://exhale.readthedocs.io/en/latest/
* You might also find the following extensions useful;
- https://github.com/mithro/sphinxcontrib-session
- https://github.com/SymbiFlow/sphinxcontrib-verilog-diagrams
- https://github.com/SymbiFlow/sphinx_materialdesign_theme

Example of how to set this up can be found at https://github.com/SymbiFlow/sphinxcontrib-verilog-diagrams/tree/master/docs and https://github.com/SymbiFlow/sphinxcontrib-verilog-diagrams/blob/master/.readthedocs.yml

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the linked Sphinx and exhale documentation, then compare the referenced docs directory and .readthedocs.yml examples. Define the repository's Sphinx generation and Read the Docs setup, including any useful extensions, and verify that the generated documentation publishes successfully.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.