diff --git a/.gitignore b/.gitignore index 096b70f..fba0dcd 100644 --- a/.gitignore +++ b/.gitignore @@ -8,5 +8,6 @@ /src/obj-strict/ /src/obj-asan/ /src/obj-ubsan/ +/site/ /tests/__pycache__/ *.pyc diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..a8947e2 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,17 @@ +# Read the Docs configuration file +# See https://docs.readthedocs.com/platform/stable/config-file/v2.html + +version: 2 + +build: + os: ubuntu-24.04 + tools: + python: "3.12" + +mkdocs: + configuration: mkdocs.yml + fail_on_warning: true + +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/assets/neurosim_logo.png b/docs/assets/neurosim_logo.png new file mode 100644 index 0000000..72cc088 Binary files /dev/null and b/docs/assets/neurosim_logo.png differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..b479262 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,16 @@ +# NS-Cache + +NeuroSim logo + +Documentation is under construction. + +NS-Cache is an early exploration tool for cache memories in advanced +technology nodes. The documentation site will include: + +- Installation and build instructions. +- Configuration examples. +- Model and parameter references. +- gem5 integration guidance. + +For the current usage notes, see the +[repository README](https://github.com/neurosim/NS-Cache#readme). diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..f2caded --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +mkdocs==1.6.1 diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..69f230a --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,12 @@ +site_name: NS-Cache +site_description: Early exploration of cache memories in advanced technology nodes +site_url: !ENV READTHEDOCS_CANONICAL_URL +repo_url: https://github.com/neurosim/NS-Cache +repo_name: neurosim/NS-Cache +edit_uri: edit/main/docs/ + +theme: + name: readthedocs + +nav: + - Home: index.md