Skip to content

RISC-V template repository for Markdown-based documentation published to Read-the-docs

License

Notifications You must be signed in to change notification settings

riscv-admin/template-docs-rtd

Repository files navigation

Template for RISC-V Markdown Docs published via the Read the Docs

This GitHub template is based on the Read the Docs tutorial here:

https://docs.readthedocs.io/en/stable/tutorial/

The base tutorial is modified to remove python source code and assume the documentation is built in markdown (MD).

The build process remains as Sphinx and template remains Read the Docs.

Type make html in the top-level directory to build the document in build/html/.

For more information on using Markdown, see the MyST Project documetation

NOTE: This template should only be used for RISC-V documentation, not for specifications. Specifications should be built using riscv/docs-spec-template.

About

RISC-V template repository for Markdown-based documentation published to Read-the-docs

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published