From 894b7369f21784685730a4ced306f8b27836210e Mon Sep 17 00:00:00 2001 From: Unai Martinez-Corral Date: Tue, 15 Mar 2022 23:29:10 +0100 Subject: [PATCH] docs: add Glossary Signed-off-by: Unai Martinez-Corral --- docs/glossary.rst | 7 +++++++ docs/index.rst | 10 ++++++++++ 2 files changed, 17 insertions(+) create mode 100644 docs/glossary.rst diff --git a/docs/glossary.rst b/docs/glossary.rst new file mode 100644 index 0000000..62ae531 --- /dev/null +++ b/docs/glossary.rst @@ -0,0 +1,7 @@ +Glossary +######## + +.. glossary:: + + File + A representation of a physical file. diff --git a/docs/index.rst b/docs/index.rst index 5c73ad3..69fec91 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,6 +7,7 @@ Think of it as the GCC of FPGAs. The project aim is to design tools that are highly extendable and multiplatform. + .. toctree:: :caption: About F4PGA @@ -15,6 +16,7 @@ The project aim is to design tools that are highly extendable and multiplatform. status getting-started + .. toctree:: :caption: Design Flows @@ -24,13 +26,21 @@ The project aim is to design tools that are highly extendable and multiplatform. flows/bitstream flows/f4pga + .. toctree:: :caption: Specifications FPGA Assembly (FASM) ➚ + .. toctree:: :caption: Contributing contributing/building-docs contributing/venv + + +.. toctree:: + :caption: Appendix + + glossary