From 40559f00b496ff1e99082e79daa945c9c3ad4081 Mon Sep 17 00:00:00 2001 From: Anton Lydike Date: Fri, 23 Apr 2021 21:15:13 +0200 Subject: [PATCH] Added instruction on how to build docs locally to README --- README.md | 6 +++++- sphinx-docs/requirements.txt | 3 ++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 34a4348..9bbe278 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# RISC-V (userspace) emulator in python +# RiscEmu - RISC-V (userspace) emulator in python Implementing a basic RISC-V emulator, aimed at being easily extendable. @@ -76,6 +76,10 @@ See [docs/debugging.md](docs/debugging.md) for more info. ## The source code: Check out the [documentation](https://riscemu.readthedocs.io/en/latest/riscemu.html). +## Accessing local documentation: +To generate your local documentation, first install everything in `sphinx-docs/requirements.txt`. Then run `./generate-docs.sh`, which will +generate and make all doc files for you. Finally, you can open the docs locall by runnint `open sphinx-docs/build/html/index.html`. + ## Resources: * Pseudo ops: https://www.codetd.com/article/8981522 * detailed instruction definition: https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#add diff --git a/sphinx-docs/requirements.txt b/sphinx-docs/requirements.txt index 2ff3af2..085b3a7 100644 --- a/sphinx-docs/requirements.txt +++ b/sphinx-docs/requirements.txt @@ -1 +1,2 @@ -recommonmark \ No newline at end of file +sphinx +recommonmark