Merge pull request #526 from antmicro/umarcor/subdir-docs

rename 'source' to 'docs'; add section 'Contributing' and README.md

.gitignore

@@ -1,4 +1,2 @@
-/source/_build/
-/source/env/
 *.pyc
 *.sw*

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 <target>' where <target> is one of"

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)

docs/.gitignore

@@ -0,0 +1,2 @@
+/_build/
+/env/

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

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``.

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 ➚ <https://f4pga.readthedocs.io/projects/prjxray/en/latest/>
    Project Trellis ➚ <https://prjtrellis.readthedocs.io/en/latest/>
    FPGA Assembly (FASM) ➚ <https://fasm.readthedocs.io/en/latest/>
+
+.. toctree::
+   :caption: Contributing
+
+   contributing/building-docs
+   contributing/venv

environment.yml

@@ -8,4 +8,4 @@ dependencies:
   - pygobject
   - pip
   - pip:
-    - -r requirements.txt
+    - -r docs/requirements.txt

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: []