From 08fc81e91587bd1b29a26a2d07f4bdd21f5571a2 Mon Sep 17 00:00:00 2001 From: Unai Martinez-Corral Date: Mon, 14 Feb 2022 22:05:55 +0100 Subject: [PATCH] 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