diff --git a/.gitignore b/.gitignore index 4611acf..cbf0fa6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,2 @@ -/source/_build/ -/source/env/ *.pyc *.sw* diff --git a/Makefile b/Makefile index dcd8ed0..90e7f84 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,7 @@ TOP_DIR := $(realpath $(dir $(lastword $(MAKEFILE_LIST)))) # A pip `requirements.txt` file. -REQUIREMENTS_FILE := requirements.txt +REQUIREMENTS_FILE := docs/requirements.txt # A conda `environment.yml` file. ENVIRONMENT_FILE := environment.yml @@ -21,7 +21,7 @@ BUILDDIR = _build # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) docs help: @echo "Please use \`make ' where is one of" diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..17fc963 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,2 @@ +/_build/ +/env/ diff --git a/source/_static/favicon.svg b/docs/_static/favicon.svg similarity index 100% rename from source/_static/favicon.svg rename to docs/_static/favicon.svg diff --git a/source/_static/images/EDA.svg b/docs/_static/images/EDA.svg similarity index 100% rename from source/_static/images/EDA.svg rename to docs/_static/images/EDA.svg diff --git a/source/_static/images/parts.svg b/docs/_static/images/parts.svg similarity index 100% rename from source/_static/images/parts.svg rename to docs/_static/images/parts.svg diff --git a/source/_static/images/toolchain-flow.svg b/docs/_static/images/toolchain-flow.svg similarity index 100% rename from source/_static/images/toolchain-flow.svg rename to docs/_static/images/toolchain-flow.svg diff --git a/source/_static/logo.svg b/docs/_static/logo.svg similarity index 100% rename from source/_static/logo.svg rename to docs/_static/logo.svg diff --git a/source/conf.py b/docs/conf.py similarity index 100% rename from source/conf.py rename to docs/conf.py diff --git a/source/index.rst b/docs/index.rst similarity index 100% rename from source/index.rst rename to docs/index.rst diff --git a/source/introduction.rst b/docs/introduction.rst similarity index 100% rename from source/introduction.rst rename to docs/introduction.rst diff --git a/source/toolchain-desc/design-flow.rst b/docs/toolchain-desc/design-flow.rst similarity index 100% rename from source/toolchain-desc/design-flow.rst rename to docs/toolchain-desc/design-flow.rst diff --git a/source/toolchain-desc/index.rst b/docs/toolchain-desc/index.rst similarity index 100% rename from source/toolchain-desc/index.rst rename to docs/toolchain-desc/index.rst diff --git a/source/toolchain-desc/yosys.rst b/docs/toolchain-desc/yosys.rst similarity index 100% rename from source/toolchain-desc/yosys.rst rename to docs/toolchain-desc/yosys.rst diff --git a/environment.yml b/environment.yml index 60b8d98..a82d238 100644 --- a/environment.yml +++ b/environment.yml @@ -8,4 +8,4 @@ dependencies: - pygobject - pip - pip: - - -r requirements.txt + - -r docs/requirements.txt diff --git a/readthedocs.yml b/readthedocs.yml index 9c71e97..0f2632f 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -7,7 +7,7 @@ version: 2 # Build documentation in the docs/ directory with Sphinx sphinx: - configuration: source/conf.py + configuration: docs/conf.py # Optionally build your docs in additional formats such as PDF and ePub formats: []