Merge branch 'javier_suggested_improvements' into 'master'

Suggested improvements to make the FPGA device id document easier to understand for beginners and non-experts See merge request !1

Merge branch 'javier_suggested_improvements' into 'master'
Suggested improvements to make the FPGA device id document easier to understand for beginners and non-experts See merge request !1
9b31ba38 · Federico Vaga · 990fb9cc · 86954390 · 9b31ba38 · 9b31ba38
Commit 9b31ba38 authored Apr 25, 2020 by Federico Vaga
6 changed files
--- a/conf.py
+++ b/conf.py
@@ -26,7 +26,7 @@ author = 'Federico Vaga'
 # The short X.Y version
 version = '1.0'
 # The full version, including alpha/beta/rc tags
-release = '1.0.0'
+release = '1.0.1'


 # -- General configuration ---------------------------------------------------
@@ -153,3 +153,7 @@ texinfo_documents = [
     author, 'FPGAInterfaceDesign', 'One line description of project.',
     'Miscellaneous'),
 ]
+
+# -- Options for figure numbering  -------------------------------------------
+
+numfig = True
--- a/device-structure.rst
+++ b/device-structure.rst
--- a/figures/spec_diagram.drawio
+++ b/figures/spec_diagram.drawio
+<mxfile host="Electron" modified="2020-04-25T13:36:03.371Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/12.9.9 Chrome/80.0.3987.163 Electron/8.2.1 Safari/537.36" etag="ch8Vc4yg-6_9YL1pl5OV" version="12.9.9" type="device"><diagram id="SzhgicpeSOI8UjnDt0E-" name="Page-1">7V1bd5u4Fv41WWvOQ7wE4qbH1Je0a07TTNIzbZ/OIjaxmWLjYpLY/fUjzMUINrZ8QSjYeYkRAuP9fdo3bYkr3J0ubwN7PvnsjxzvSkWj5RXuXamqgnWd/otaVnEL0ZKGceCOkk6bhkf3t8M2vrgjZ8E0hb7vhe6cbRz6s5kzDJk2Owj8N7bbs++xXzq3x06p4XFoe+XWb+4onMStlmpu2j867niSfrNikPjM1E47o7hhMbFH/luuCfevcDfw/TD+NF12HS+SXSqW+LpBxdnswQJnFvJcgP66XX3v/u/rb/X24wQN5z//WSyvcXyXV9t7SX5w8rDhKpWAMxvdRIKkRzN/Rhs/TMKpR48U+nERBv7PTDKYtpQfK3lSZ8RIOnnIW8efOmGwoh3eNvLVE5lNcqJN2wLHs0P3lcXHTmAeZ7fLvuHed+mTqChhpJXcJqGjgRB7h4X/Egyd5KK8OLffR9UK9wntYOyEpfvQD7kfvWlag7UHcNoFuAOBU9GOG9WMnH52yO2U+MHQCR50xgW6osR5ocNqs9CZZwddSeKHjrqmobMu0B3upDRr68jZQbdT4odCJ9rBVNAZYrdd4rzQmYR0SO7PahZIBQDS8KjoPjzRD+Pow+BzN0LW88O1sKmsVXTTi9qmzu/f9syl4CbX0GfILisR4m3ihs7j3B5Gx2+BPWcpYS/mcYz+7C6d0X4ceXWC0FluZQkMI06ZnCNR5tbkWaQWh2qeMQwqe0PAEWZLIbpMVqt0YJVlZwGis2qTHI/f5nnufBFpH0lkaLIWwLJKMlSI2tHLYsw1n16SUNwZD+lnf629NiI1fr346YnrxTold0M7KGi+3JzcKIGCMrnvfqLaAvX6f///Uw9WG1lb/NUV2iTwX2ajCKge4gDXc8cz+tlznsMStMqJoFVxR9UZdE1TL6MLaRelNmB5/GPJhgguqBkdUtGQhq5Lhsc6qlQWwep7wtT1wY/ogI7m5LC3zJ/srdKjpRt+z33OXUWPNhdFB+k1e0ASeywc+jX2QThYJomrhgtGXi9aIF5fTStSEYv1ztRj3eyUQUqeQVv5k3FVYbi6g6knZZ3FyzrzwrpaWFcdE9TjDPzdv+t9eTgHf8AomzKx/kCqQOrHttt/uBOO55DC5QR1IarxIQrFQPUBCkWPtQD6eN/vngGggMsuFlBoHqkWQDudTusVLmlc4UI5itbAKX54AoAKHZ4Yco5kzNZpOutFZmLKh9GQ6OrL12HI+dgnnFlQzzdMTw89e7Fwh2nzwPWqJxeyqOYadRBiQ5sOUcmuQDw6uncCl8ohovu6sRKjnYELTupzJAlcsjmHY6fxizfSDbGBC96vYG1DII5cjbkrWcNwM6FunpjxFaOtND2cUukkgqSUKjGBm1KkcCNFMKWgUjowiuWYAKOaOywqtIgCXd/zgw1rnilFCk0lexvZAXdoezfJiak7GnlVKVzWtJ/AtpTg1cq2RYNMS22WhSNFu5eDU49JNlmxaVA6AJIbqU1uellBUg3ymBz6QTjxx/7M9vqb1gKdNn3+6/vzRHz/OGG4Ssq17ZfQP8iMg6r6YBW6O++Iec034dS1+ylR+lvtVa7DPNJpi2odW3Tw0kFYmVbc3p9+iJ/gpPpT43H55Jp/0i3MykkFHGeRyk07tg5f0vmnnQMtJY8kTo1uRsHD5k9laGLqWhas7uvlGEXKCa7E045dMPAe55kkY5eBCxzQD3SZTax1MCJINQ2LqEhXmNsaltFRCCJmVM5jEl0RSjRdWJ3Jl8Hgsf+V9n/o37Yqy6mZRjEplvmVjWU59eqkdWH+AH24eexfrQuAPnX75xU2QdBBCWrIuyjOAZ8OuuoEdQZJXO357eFrr4TcU5B2+iOk7r+KPOfV8f5TPn1eUOsmYXDGBKjzE4qzwbG0bEzlMD/Sr85W29pP6W3RDlEV0o86KYtKfElkan6bi1y2w7ibis3KTxNWRdJsLWleF12p+PnZMYbDkuKiZ0YmeUJlJxZ2C47FPnUqi/bGMhr2FDRhHmDjVUXvixmm0jQzhBU+NFuaJDUtFMRDDKEz7pqwCgomQrnQg48egEURSw9ohUNrCmzepSlRUOO2BJoPbA0p3q2ugIghVFkY72/FIGHTwumih2aDO0OY0pUquCNkMCAEGmDE7CHT5Bxg+3OAlEcSbljFGsJUrGyBnDwsgBYPCyWBCSXJ2h+zNcUAhYsCQi2qKSzNl5+EuPCAxyCIJYLaZpdbdkugKI2bAmEL0WQKuWTSAAAFxGoAnioiuYIrXSnFqLjpcj8TmiEpirFtxVgG71YTKckkqdrSTLVjWQoyTEtRCFIVjfXOor2+LIJVxbIQsZDF3p+7PhCZnfXtk5Iu5jtUHXdoj01FF2a/pO69M4/d9zSrMu2opp6nbIdohI+2TF2rsoO20S2Ka7kuVI5WIygds5BsKq624SUspFexWF5is0zD+pc2VGjSnaXWjSyJ2L2qjHcLxmOpR9hqKY2Td3svmShs0ZJ+T+WSie3961kyYXIU5A3ub2/Oq6COGj7W6gHzjkKXnFnVqa/ShPKXm4eKpEVb4Sos21SBPdwy4yIGLo51+8OX4HUthEpVC7ktjMsibnO2tJT+vbkZ2LJKRdDWgetmtBTVTD/z+Rj7L7Vjd+nVTGv7cxX769vtjG6xYQNOYsDK/gZ7f6zt6K+xfh021JPasbuP32avyrc/v0x+de8+evjt19K95thZ+PZOU1T601F2JkhPJVuDPQVuRNuz0p2H7rN7itJx/+XHYvBjNXuc3X+e/qX/fLWuNfA9QO2f7D1RNcX+ng5iB2taeSEiswvCX70FQssnemVhAOQ8CWWAsJptqWZ5m4Lf3A1/XXl9EH1hddktrr89mgSAFRBKglZvYye3+gc2bhOr/ltdYS37wAfQFzrwhZX5oSVCZz7yddkcP/A9T3Whr13Q32XyBaMvrLbvYvSL4Ddu9BVVFPhSZX2aKugqOn2KIbDAHyaAsLSfbHkfaTigCSzqhDkgLPcnVeanKQIUfX+IAEKdf3HvhbtU91ezADAFYllwDq+kkAT8kg0wG7cBrU79ST/4AfzFDn5h2T+0VJE0KaCm8C/GgRL4gAIzgJQAsmSBpCEAdyBo1EQA8C2UrTEAkqPfuPlXheWBZNiyt0CDwfoPokG8BbgwLzDNxjVHA2HZoIbcgCpHsCkKlBxBgAJCHUFxb7JDS00WN7Ap9Et2oHEFwPVyrSNX9/KJtwBR1vMUejfdhDIRe7ouKS91QOZ1iRwKvdoucgUBO1wJlDnHm6RaKHMgxhAncw0KMFov8/RtmA3JnGM9VPtkDrynTqTMoVCq9TLHwJbjAmVeHbds5h796dxzwmi9UbywFk2dqb/+UVMq9rNafKSn74JK4QOKkAiA3ykWbsIA8myH0rZBo0I76AocNDx7erRP5o06++A25+2XOaBeTiFzehj4UZYhO3dLhTT57I+cqMe/</diagram></mxfile>
\ No newline at end of file
--- a/figures/spec_diagram.png
+++ b/figures/spec_diagram.png
--- a/figures/spec_diagram.svg
+++ b/figures/spec_diagram.svg
--- a/index.rst
+++ b/index.rst
@@ -2,14 +2,17 @@
 FPGA Device Identification
 ==========================

-The purpose of this document is to aide HDL developers in designing FPGA
-applications so that the exported interface can be easily used by the
-correspondent low-level software.
+The purpose of this document is to help HDL designers in the development of FPGA
+designs so that the exported interface can be easily used by the corresponding
+low-level software.

-This document is tailored around the CERN BE-CO-HT needs to handle different
-FPGA applications on SVEC, SPEC and similar FMC carrier boards.
+This document is tailored to the needs of the BE-CO-HT section at CERN to handle
+different FPGA designs on the SVEC_, SPEC_ and similar FMC carrier boards.

 .. toctree::
   :maxdepth: 1

   device-structure
+
+.. _SVEC: https://www.ohwr.org/project/svec/wikis
+.. _SPEC: https://www.ohwr.org/project/spec/wikis