diff --git a/.github/workflows/doc-build.yml b/.github/workflows/doc-build.yml new file mode 100644 index 0000000..39929ec --- /dev/null +++ b/.github/workflows/doc-build.yml @@ -0,0 +1,27 @@ +name: doc-build + +on: [push, pull_request, workflow_dispatch] + +permissions: + contents: write + +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + - name: Install dependencies + run: | + pip install sphinx sphinx_rtd_theme myst_parser + - name: Sphinx build + run: | + make html + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} + with: + publish_branch: gh-pages + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: docs/html + force_orphan: true diff --git a/.gitignore b/.gitignore index e0f60f5..22e14f6 100644 --- a/.gitignore +++ b/.gitignore @@ -27,7 +27,7 @@ __pycache__/ # Distribution / packaging .Python -#build/ +build/ develop-eggs/ dist/ downloads/ @@ -88,7 +88,7 @@ instance/ .scrapy # Sphinx documentation -docs/_build/ +docs/_build # PyBuilder .pybuilder/ @@ -156,5 +156,4 @@ cython_debug/ # End of https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks # Other items not to include for RISC-V usage -docs/conf.py -docs/json/ +docs/ diff --git a/docs/Makefile b/Makefile similarity index 96% rename from docs/Makefile rename to Makefile index d0c3cbf..1ed714b 100644 --- a/docs/Makefile +++ b/Makefile @@ -6,7 +6,7 @@ SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build SOURCEDIR = source -BUILDDIR = build +BUILDDIR = docs # Put it first so that "make" without argument is like "make help". help: diff --git a/README.md b/README.md index c629d96..60b9493 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,21 @@ -# Template for RISC-V Markdown Docs published via the Read the Docs +# RISC-V Ecosystem Lab Partners Documentation Project -This GitHub template is based on the Read the Docs tutorial -here: +The documentation in this repo is based on the [riscv-admin/template-docs-rtd](https://github.com/riscv-admin/template-docs-rtd/) +project. It supports building documents with Sphinx in MD and RST, and then publishing to GitHub pages. -https://docs.readthedocs.io/en/stable/tutorial/ +To contribute to this project, join the [RISC-V Ecosystem Lab Partners](https://lists.riscv.org/g/lab-partners) +in the RISC-V Portal. -The base tutorial is modified to remove python source code -and assume the documentation is built in markdown (MD). +The projects currently being developed are: + +1. Becoming an Ecosystem Lab Partner +2. Hosting CI for a community + +The current published pages can be found at [https://riscv-admin.github.io/labs-doc/](https://riscv-admin.github.io/labs-doc/). The build process remains as Sphinx and template remains Read the Docs. -Type `make html` in the `build` directory to build the document in `build/html/`. +Type `make html` in the top directory to build the document in `docs/html/`. For more information on using Markdown, see the [MyST Project documetation](https://myst-parser.readthedocs.io/en/latest/index.html) diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle deleted file mode 100644 index 9cec6b1..0000000 Binary files a/docs/build/doctrees/environment.pickle and /dev/null differ diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle new file mode 100644 index 0000000..f4dfb12 Binary files /dev/null and b/docs/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/index.doctree b/docs/doctrees/index.doctree similarity index 94% rename from docs/build/doctrees/index.doctree rename to docs/doctrees/index.doctree index a81f1bc..569c661 100644 Binary files a/docs/build/doctrees/index.doctree and b/docs/doctrees/index.doctree differ diff --git a/docs/build/html/.buildinfo b/docs/html/.buildinfo similarity index 100% rename from docs/build/html/.buildinfo rename to docs/html/.buildinfo diff --git a/docs/build/html/_sources/index.md.txt b/docs/html/_sources/index.md.txt similarity index 100% rename from docs/build/html/_sources/index.md.txt rename to docs/html/_sources/index.md.txt diff --git a/docs/build/html/_static/RISC-V-Logo.svg b/docs/html/_static/RISC-V-Logo.svg similarity index 100% rename from docs/build/html/_static/RISC-V-Logo.svg rename to docs/html/_static/RISC-V-Logo.svg diff --git a/docs/build/html/_static/_sphinx_javascript_frameworks_compat.js b/docs/html/_static/_sphinx_javascript_frameworks_compat.js similarity index 100% rename from docs/build/html/_static/_sphinx_javascript_frameworks_compat.js rename to docs/html/_static/_sphinx_javascript_frameworks_compat.js diff --git a/docs/build/html/_static/basic.css b/docs/html/_static/basic.css similarity index 100% rename from docs/build/html/_static/basic.css rename to docs/html/_static/basic.css diff --git a/docs/build/html/_static/css/badge_only.css b/docs/html/_static/css/badge_only.css similarity index 100% rename from docs/build/html/_static/css/badge_only.css rename to docs/html/_static/css/badge_only.css diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff b/docs/html/_static/css/fonts/Roboto-Slab-Bold.woff similarity index 100% rename from docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff rename to docs/html/_static/css/fonts/Roboto-Slab-Bold.woff diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 b/docs/html/_static/css/fonts/Roboto-Slab-Bold.woff2 similarity index 100% rename from docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 rename to docs/html/_static/css/fonts/Roboto-Slab-Bold.woff2 diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff b/docs/html/_static/css/fonts/Roboto-Slab-Regular.woff similarity index 100% rename from docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff rename to docs/html/_static/css/fonts/Roboto-Slab-Regular.woff diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 b/docs/html/_static/css/fonts/Roboto-Slab-Regular.woff2 similarity index 100% rename from docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 rename to docs/html/_static/css/fonts/Roboto-Slab-Regular.woff2 diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.eot b/docs/html/_static/css/fonts/fontawesome-webfont.eot similarity index 100% rename from docs/build/html/_static/css/fonts/fontawesome-webfont.eot rename to docs/html/_static/css/fonts/fontawesome-webfont.eot diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.svg b/docs/html/_static/css/fonts/fontawesome-webfont.svg similarity index 100% rename from docs/build/html/_static/css/fonts/fontawesome-webfont.svg rename to docs/html/_static/css/fonts/fontawesome-webfont.svg diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.ttf b/docs/html/_static/css/fonts/fontawesome-webfont.ttf similarity index 100% rename from docs/build/html/_static/css/fonts/fontawesome-webfont.ttf rename to docs/html/_static/css/fonts/fontawesome-webfont.ttf diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.woff b/docs/html/_static/css/fonts/fontawesome-webfont.woff similarity index 100% rename from docs/build/html/_static/css/fonts/fontawesome-webfont.woff rename to docs/html/_static/css/fonts/fontawesome-webfont.woff diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.woff2 b/docs/html/_static/css/fonts/fontawesome-webfont.woff2 similarity index 100% rename from docs/build/html/_static/css/fonts/fontawesome-webfont.woff2 rename to docs/html/_static/css/fonts/fontawesome-webfont.woff2 diff --git a/docs/build/html/_static/css/fonts/lato-bold-italic.woff b/docs/html/_static/css/fonts/lato-bold-italic.woff similarity index 100% rename from docs/build/html/_static/css/fonts/lato-bold-italic.woff rename to docs/html/_static/css/fonts/lato-bold-italic.woff diff --git a/docs/build/html/_static/css/fonts/lato-bold-italic.woff2 b/docs/html/_static/css/fonts/lato-bold-italic.woff2 similarity index 100% rename from docs/build/html/_static/css/fonts/lato-bold-italic.woff2 rename to docs/html/_static/css/fonts/lato-bold-italic.woff2 diff --git a/docs/build/html/_static/css/fonts/lato-bold.woff b/docs/html/_static/css/fonts/lato-bold.woff similarity index 100% rename from docs/build/html/_static/css/fonts/lato-bold.woff rename to docs/html/_static/css/fonts/lato-bold.woff diff --git a/docs/build/html/_static/css/fonts/lato-bold.woff2 b/docs/html/_static/css/fonts/lato-bold.woff2 similarity index 100% rename from docs/build/html/_static/css/fonts/lato-bold.woff2 rename to docs/html/_static/css/fonts/lato-bold.woff2 diff --git a/docs/build/html/_static/css/fonts/lato-normal-italic.woff b/docs/html/_static/css/fonts/lato-normal-italic.woff similarity index 100% rename from docs/build/html/_static/css/fonts/lato-normal-italic.woff rename to docs/html/_static/css/fonts/lato-normal-italic.woff diff --git a/docs/build/html/_static/css/fonts/lato-normal-italic.woff2 b/docs/html/_static/css/fonts/lato-normal-italic.woff2 similarity index 100% rename from docs/build/html/_static/css/fonts/lato-normal-italic.woff2 rename to docs/html/_static/css/fonts/lato-normal-italic.woff2 diff --git a/docs/build/html/_static/css/fonts/lato-normal.woff b/docs/html/_static/css/fonts/lato-normal.woff similarity index 100% rename from docs/build/html/_static/css/fonts/lato-normal.woff rename to docs/html/_static/css/fonts/lato-normal.woff diff --git a/docs/build/html/_static/css/fonts/lato-normal.woff2 b/docs/html/_static/css/fonts/lato-normal.woff2 similarity index 100% rename from docs/build/html/_static/css/fonts/lato-normal.woff2 rename to docs/html/_static/css/fonts/lato-normal.woff2 diff --git a/docs/build/html/_static/css/risc-v.css b/docs/html/_static/css/risc-v.css similarity index 100% rename from docs/build/html/_static/css/risc-v.css rename to docs/html/_static/css/risc-v.css diff --git a/docs/build/html/_static/css/theme.css b/docs/html/_static/css/theme.css similarity index 100% rename from docs/build/html/_static/css/theme.css rename to docs/html/_static/css/theme.css diff --git a/docs/build/html/_static/doctools.js b/docs/html/_static/doctools.js similarity index 100% rename from docs/build/html/_static/doctools.js rename to docs/html/_static/doctools.js diff --git a/docs/build/html/_static/documentation_options.js b/docs/html/_static/documentation_options.js similarity index 100% rename from docs/build/html/_static/documentation_options.js rename to docs/html/_static/documentation_options.js diff --git a/docs/build/html/_static/file.png b/docs/html/_static/file.png similarity index 100% rename from docs/build/html/_static/file.png rename to docs/html/_static/file.png diff --git a/docs/build/html/_static/jquery.js b/docs/html/_static/jquery.js similarity index 100% rename from docs/build/html/_static/jquery.js rename to docs/html/_static/jquery.js diff --git a/docs/build/html/_static/js/badge_only.js b/docs/html/_static/js/badge_only.js similarity index 100% rename from docs/build/html/_static/js/badge_only.js rename to docs/html/_static/js/badge_only.js diff --git a/docs/build/html/_static/js/html5shiv-printshiv.min.js b/docs/html/_static/js/html5shiv-printshiv.min.js similarity index 100% rename from docs/build/html/_static/js/html5shiv-printshiv.min.js rename to docs/html/_static/js/html5shiv-printshiv.min.js diff --git a/docs/build/html/_static/js/html5shiv.min.js b/docs/html/_static/js/html5shiv.min.js similarity index 100% rename from docs/build/html/_static/js/html5shiv.min.js rename to docs/html/_static/js/html5shiv.min.js diff --git a/docs/build/html/_static/js/theme.js b/docs/html/_static/js/theme.js similarity index 100% rename from docs/build/html/_static/js/theme.js rename to docs/html/_static/js/theme.js diff --git a/docs/build/html/_static/language_data.js b/docs/html/_static/language_data.js similarity index 100% rename from docs/build/html/_static/language_data.js rename to docs/html/_static/language_data.js diff --git a/docs/build/html/_static/minus.png b/docs/html/_static/minus.png similarity index 100% rename from docs/build/html/_static/minus.png rename to docs/html/_static/minus.png diff --git a/docs/build/html/_static/plus.png b/docs/html/_static/plus.png similarity index 100% rename from docs/build/html/_static/plus.png rename to docs/html/_static/plus.png diff --git a/docs/build/html/_static/pygments.css b/docs/html/_static/pygments.css similarity index 100% rename from docs/build/html/_static/pygments.css rename to docs/html/_static/pygments.css diff --git a/docs/build/html/_static/riscv-favicon-32x32.png b/docs/html/_static/riscv-favicon-32x32.png similarity index 100% rename from docs/build/html/_static/riscv-favicon-32x32.png rename to docs/html/_static/riscv-favicon-32x32.png diff --git a/docs/build/html/_static/searchtools.js b/docs/html/_static/searchtools.js similarity index 100% rename from docs/build/html/_static/searchtools.js rename to docs/html/_static/searchtools.js diff --git a/docs/build/html/_static/sphinx_highlight.js b/docs/html/_static/sphinx_highlight.js similarity index 100% rename from docs/build/html/_static/sphinx_highlight.js rename to docs/html/_static/sphinx_highlight.js diff --git a/docs/build/html/genindex.html b/docs/html/genindex.html similarity index 100% rename from docs/build/html/genindex.html rename to docs/html/genindex.html diff --git a/docs/build/html/index.html b/docs/html/index.html similarity index 100% rename from docs/build/html/index.html rename to docs/html/index.html diff --git a/docs/build/html/objects.inv b/docs/html/objects.inv similarity index 100% rename from docs/build/html/objects.inv rename to docs/html/objects.inv diff --git a/docs/build/html/search.html b/docs/html/search.html similarity index 100% rename from docs/build/html/search.html rename to docs/html/search.html diff --git a/docs/build/html/searchindex.js b/docs/html/searchindex.js similarity index 100% rename from docs/build/html/searchindex.js rename to docs/html/searchindex.js diff --git a/docs/source/index.md b/docs/source/index.md deleted file mode 100644 index e7f41ae..0000000 --- a/docs/source/index.md +++ /dev/null @@ -1,10 +0,0 @@ -# RISC-V Sample Document - -This is a **sample** document text. - -Type `make html` in the `docs` directory to build the document. - -The resulting HTML will be found in `build/html/` directory. - -For more information on using Markdown, see the -[MyST Project documetation](https://myst-parser.readthedocs.io/en/latest/index.html) diff --git a/docs/make.bat b/make.bat similarity index 100% rename from docs/make.bat rename to make.bat diff --git a/docs/source/RISC-V-Logo.svg b/source/RISC-V-Logo.svg similarity index 100% rename from docs/source/RISC-V-Logo.svg rename to source/RISC-V-Logo.svg diff --git a/docs/source/_static/css/risc-v.css b/source/_static/css/risc-v.css similarity index 100% rename from docs/source/_static/css/risc-v.css rename to source/_static/css/risc-v.css diff --git a/docs/source/_static/riscv-favicon-32x32.png b/source/_static/riscv-favicon-32x32.png similarity index 100% rename from docs/source/_static/riscv-favicon-32x32.png rename to source/_static/riscv-favicon-32x32.png diff --git a/source/becoming_lab_partner.md b/source/becoming_lab_partner.md new file mode 100644 index 0000000..7d1a351 --- /dev/null +++ b/source/becoming_lab_partner.md @@ -0,0 +1,3 @@ +# Becoming an RISC-V Ecosystem Labs Partner + +Yada yada... diff --git a/source/ci_hosting.md b/source/ci_hosting.md new file mode 100644 index 0000000..2999ea2 --- /dev/null +++ b/source/ci_hosting.md @@ -0,0 +1,3 @@ +# Hosting a Continuous Integration (CI) Project at a Lab + +Good details to come... diff --git a/docs/source/conf.py b/source/conf.py similarity index 97% rename from docs/source/conf.py rename to source/conf.py index e6bdc93..e378e9a 100644 --- a/docs/source/conf.py +++ b/source/conf.py @@ -2,7 +2,7 @@ # -- Project information -project = '' +project = 'RISC-V Labs Documentation>' copyright = '2024, RISC-V International' author = 'RISC-V International' release = '0.1' diff --git a/source/index.rst b/source/index.rst new file mode 100644 index 0000000..bc8d72e --- /dev/null +++ b/source/index.rst @@ -0,0 +1,14 @@ + +========================================== +RISC-V Labs Best Practices Documentation +========================================== + +TBD overview... + +Documents + +.. toctree:: + :maxdepth: 2 + + becoming_lab_partner + ci_hosting