From 6be52fd7e7be7e946d092961dce0590a169e1b80 Mon Sep 17 00:00:00 2001 From: Unai Martinez-Corral Date: Mon, 14 Feb 2022 22:05:13 +0100 Subject: [PATCH 1/2] rename 'source' to 'docs' Signed-off-by: Unai Martinez-Corral --- .gitignore | 2 -- Makefile | 4 ++-- docs/.gitignore | 2 ++ {source => docs}/_static/favicon.svg | 0 {source => docs}/_static/images/EDA.svg | 0 {source => docs}/_static/images/parts.svg | 0 {source => docs}/_static/images/toolchain-flow.svg | 0 {source => docs}/_static/logo.svg | 0 {source => docs}/conf.py | 0 {source => docs}/index.rst | 0 {source => docs}/introduction.rst | 0 {source => docs}/toolchain-desc/design-flow.rst | 0 {source => docs}/toolchain-desc/index.rst | 0 {source => docs}/toolchain-desc/yosys.rst | 0 environment.yml | 2 +- readthedocs.yml | 2 +- 16 files changed, 6 insertions(+), 6 deletions(-) create mode 100644 docs/.gitignore rename {source => docs}/_static/favicon.svg (100%) rename {source => docs}/_static/images/EDA.svg (100%) rename {source => docs}/_static/images/parts.svg (100%) rename {source => docs}/_static/images/toolchain-flow.svg (100%) rename {source => docs}/_static/logo.svg (100%) rename {source => docs}/conf.py (100%) rename {source => docs}/index.rst (100%) rename {source => docs}/introduction.rst (100%) rename {source => docs}/toolchain-desc/design-flow.rst (100%) rename {source => docs}/toolchain-desc/index.rst (100%) rename {source => docs}/toolchain-desc/yosys.rst (100%) 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: [] From 08fc81e91587bd1b29a26a2d07f4bdd21f5571a2 Mon Sep 17 00:00:00 2001 From: Unai Martinez-Corral Date: Mon, 14 Feb 2022 22:05:55 +0100 Subject: [PATCH 2/2] add section 'Contributing' and README.md Signed-off-by: Unai Martinez-Corral --- README.md | 7 +++++++ docs/contributing/building-docs.rst | 15 +++++++++++++++ README.rst => docs/contributing/venv.rst | 22 +--------------------- docs/index.rst | 7 ++++++- requirements.txt => docs/requirements.txt | 0 5 files changed, 29 insertions(+), 22 deletions(-) create mode 100644 README.md create mode 100644 docs/contributing/building-docs.rst rename README.rst => docs/contributing/venv.rst (55%) rename requirements.txt => docs/requirements.txt (100%) diff --git a/README.md b/README.md new file mode 100644 index 0000000..2c8d3fc --- /dev/null +++ b/README.md @@ -0,0 +1,7 @@ +# F4PGA + +This is the entrypoint to the documentation of F4PGA. + +- [f4pga.readthedocs.io](https://f4pga.readthedocs.io) +- [f4pga.readthedocs.io/projects/arch-defs](https://f4pga.readthedocs.io/projects/arch-defs) +- [f4pga-examples.readthedocs.io](https://f4pga-examples.readthedocs.io) diff --git a/docs/contributing/building-docs.rst b/docs/contributing/building-docs.rst new file mode 100644 index 0000000..e11c541 --- /dev/null +++ b/docs/contributing/building-docs.rst @@ -0,0 +1,15 @@ +Building the documentation +########################## + +Activate the virtual environment and install dependencies:: + + make env + make enter + +Build the whole documentation:: + + make html + +For more options see:: + + make help diff --git a/README.rst b/docs/contributing/venv.rst similarity index 55% rename from README.rst rename to docs/contributing/venv.rst index 2248fe1..a303f04 100644 --- a/README.rst +++ b/docs/contributing/venv.rst @@ -1,25 +1,5 @@ -=============== -Getting Started -=============== - -Building documentation ----------------------- - -Activate the virtual environment and install dependencies:: - - make env - make enter - -Build the whole documentation:: - - make html - -For more options see:: - - make help - Packages in virtual environment -------------------------------- +############################### To install packages in conda environment you can use both ``conda`` and ``pip``. diff --git a/docs/index.rst b/docs/index.rst index a4ded67..3b0b7c7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,7 +2,6 @@ F4PGA documentation ################### .. toctree:: - :maxdepth: 3 introduction toolchain-desc/index @@ -10,3 +9,9 @@ F4PGA documentation Project X-Ray ➚ Project Trellis ➚ FPGA Assembly (FASM) ➚ + +.. toctree:: + :caption: Contributing + + contributing/building-docs + contributing/venv diff --git a/requirements.txt b/docs/requirements.txt similarity index 100% rename from requirements.txt rename to docs/requirements.txt