diff options
| -rw-r--r-- | doc/_static/theme_overrides.css | 6 | ||||
| -rw-r--r-- | doc/about.rst | 22 | ||||
| -rw-r--r-- | doc/appendix/Meta.rst | 48 | ||||
| -rw-r--r-- | doc/building/Building.rst | 1 | ||||
| -rw-r--r-- | doc/building/gcc/GNULinux-GNAT.rst | 4 | ||||
| -rw-r--r-- | doc/building/gcc/index.rst | 2 | ||||
| -rw-r--r-- | doc/getting/Releases.rst | 4 | ||||
| -rw-r--r-- | doc/index.rst | 4 |
8 files changed, 40 insertions, 51 deletions
diff --git a/doc/_static/theme_overrides.css b/doc/_static/theme_overrides.css index 4af06bdb0..7efc1c207 100644 --- a/doc/_static/theme_overrides.css +++ b/doc/_static/theme_overrides.css @@ -19,8 +19,8 @@ footer hr {margin-bottom: 10px} /*Shrink left nav to 260px*/ .wy-nav-side,.rst-versions,.wy-side-nav-search,.wy-menu-vertical{width: 260px} .wy-nav-content-wrap{margin-left:260px;background:#fcfcfc;min-height:100%} -@media screen and (max-width: 768px){ - .wy-nav-top i {padding-top:7px} +@media screen and (max-width: 768px){ + .wy-nav-top i {padding-top:7px} .wy-nav-content-wrap{margin-left:0px} .wy-nav-content-wrap.shift{margin-left:260px;position: static;} .wy-nav-side.shift{width:260px;padding-bottom: 40px;} @@ -67,4 +67,4 @@ div.wy-menu.rst-pro{display: none !important;max-width: 260px} /*Reduce margin below lists*/ .rst-content .section ul, .rst-content .toctree-wrapper ul, article ul {margin-bottom: 12px} -.rst-content blockquote {margin-bottom: 12px;}
\ No newline at end of file +.rst-content blockquote {margin-bottom: 12px;} diff --git a/doc/about.rst b/doc/about.rst index e68770efa..6d2f28c20 100644 --- a/doc/about.rst +++ b/doc/about.rst @@ -45,14 +45,14 @@ Who uses GHDL? .. container:: whouses -.. only:: html - - +-------------------+--------------------+---------------------------------------------------+----------------------------------------------------------------+ - | Project hub | Documentation | Name | Brief description | - +===================+====================+===================================================+================================================================+ - | |SHIELD:gh-poc| | |SHIELD:rtd-poc| | `PoC-Library <https://github.com/VLSI-EDA/PoC>`_ | A Vendor-Independent, Open-Source IP Core and Utility Library. | - +-------------------+--------------------+---------------------------------------------------+----------------------------------------------------------------+ - | |SHIELD:gh-vunit| | |SHIELD:doc-vunit| | `VUnit <http://vunit.github.io/>`_ | A unit testing framework for VHDL/SystemVerilog | - +-------------------+--------------------+---------------------------------------------------+----------------------------------------------------------------+ - | |SHIELD:gl-p1076| | |SHIELD:tw-p1076| | `IEEE P1076 WG <http://www.eda-twiki.org/vasg/>`_ | IEEE P1076 Working Group [VASG] | - +-------------------+--------------------+---------------------------------------------------+----------------------------------------------------------------+ + .. only:: html + + +-------------------+--------------------+----------------------------------------------------+----------------------------------------------------------------+ + | Project hub | Documentation | Name | Brief description | + +===================+====================+====================================================+================================================================+ + | |SHIELD:gh-poc| | |SHIELD:rtd-poc| | `PoC-Library <https://github.com/VLSI-EDA/PoC>`_ | A Vendor-Independent, Open-Source IP Core and Utility Library. | + +-------------------+--------------------+----------------------------------------------------+----------------------------------------------------------------+ + | |SHIELD:gh-vunit| | |SHIELD:doc-vunit| | `VUnit <https://vunit.github.io/>`_ | A unit testing framework for VHDL/SystemVerilog | + +-------------------+--------------------+----------------------------------------------------+----------------------------------------------------------------+ + | |SHIELD:gl-p1076| | |SHIELD:tw-p1076| | `IEEE P1076 WG <https://www.eda-twiki.org/vasg/>`_ | IEEE P1076 Working Group [VASG] | + +-------------------+--------------------+----------------------------------------------------+----------------------------------------------------------------+ diff --git a/doc/appendix/Meta.rst b/doc/appendix/Meta.rst index 5a95f1793..d9a667ac4 100644 --- a/doc/appendix/Meta.rst +++ b/doc/appendix/Meta.rst @@ -1,5 +1,3 @@ -.. _CHANGE:Roadmap: - Meta #### @@ -12,42 +10,41 @@ General guidelines to edit the documentation 4) Please underline all headlines with at least as many characters as the headline is long. Following the Python pattern for headlines the levels are: .. code:: - + ############ ************ (sometimes skipped in small documents) ============ ------------------- ‘’’’’’’’’’’’’’’’’’’’’’’’ - + 5) It’s not required to write - + .. code:: - - :samp:`code` - + + :samp:`code` + The default role for - + .. code:: - ``code`` + ``code`` is samp. ``:samp:`` is only required when you want to write italic text in code text. - + .. code:: - :samp:`print 1+{variable}` + :samp:`print 1+{variable}` Now, variable becomes italic. Please simplify all usages of ``:samp:`code``` to ````code```` for readability. Here are the regular expressions for an editor like Notepad++: - + - Search pattern:: :samp:`(.+?)` - - - Replace pattern:: ``\1`` + - Replace pattern:: ``\1`` - 6) Each backend has one folder and each platform/compiler has one file. Please note that page headlines are different from ToC headlines: + 6) Each backend has one folder and each platform/compiler has one file. Please note that page headlines are different from ToC headline: - .. code:: + .. code:: .. toctree:: :hidden: @@ -58,7 +55,6 @@ General guidelines to edit the documentation 7) Documentation should not use “you”, “we”, …, because it’s not an interactive conversation or informal letter. It’s like a thesis, everything is structured and formal. However, to make it more friendly to newcomers, we agree to allow informal language in the section :ref:`USING:QuickStart`. 8) Please keep errors to a minimum. - Guidelines to edit section 'Building' ************************************* @@ -73,24 +69,24 @@ We would like to see a list like: * ... The goal is also to explain what a user is installing and what the few lines in the build description do. Now they know the name, can search for similar names if they have another package manager or distro or can ask Google/Wikipedia. We often find many build receipts with cryptic shell code and to execute this unknown stuff with sudo is not comfortable. We would like to know what it does before hitting enter. - + Documentation configuration *************************** - + * Python snippet for Sphinx's `conf.py` to extract the current version number from Git (latest tag name). [:ghdlsharp:`200`, :ghdlsharp:`221`] * Reference ``genindex.html`` from the navigation bar. [:ghdlsharp:`200`] * Create "parts" (LaTeX terminology / chapter headlines) in navigation bar. [:ghdlsharp:`200`] - + * Intersphinx files [:ghdlsharp:`200`] * To decompress the inventory file: `curl -s http://ghdl.readthedocs.io/en/latest/objects.inv | tail -n+5 | openssl zlib -d`. From `how-to-uncompress-zlib-data-in-unix <http://unix.stackexchange.com/questions/22834/how-to-uncompress-zlib-data-in-unix>`_. * External ref and link to section:: - + :ref:`GHDL Roadmap <ghdl:CHANGE:Roadmap>` - + * External ref to option (no link):: - + :ghdl:option:`--ieee` :option:`ghdl:--ieee` @@ -103,8 +99,8 @@ CSS * No headlines are shown. It is not possible to remove only one of them with CSS only (JS would be required). However, because the content in most of the lines is self-explained, it is preferred not to show any. * The Search box is removed. - + Dist **** -* Ubuntu uses `dash` instead of `bash` when a shell script is run. As a result, some functionalities, such as arrays like ``array[1]``, are not supported. Therefore, build scripts in `dist/linux` should not use those functionalities unless they are sourced in a `bash` shell. That is, :file:`travis-ci.sh` uses arrays, since it is sourced in the Travis CI machine. But :file:`docker-buildtest.sh` and :file:`buildtest.sh` do not use any. The same applies to the scripts in `testsuite`.
\ No newline at end of file +* Ubuntu uses `dash` instead of `bash` when a shell script is run. As a result, some functionalities, such as arrays like ``array[1]``, are not supported. Therefore, build scripts in `dist/linux` should not use those functionalities unless they are sourced in a `bash` shell. That is, :file:`travis-ci.sh` uses arrays, since it is sourced in the Travis CI machine. But :file:`docker-buildtest.sh` and :file:`buildtest.sh` do not use any. The same applies to the scripts in `testsuite`. diff --git a/doc/building/Building.rst b/doc/building/Building.rst index 5cc5bd29d..9bdecd147 100644 --- a/doc/building/Building.rst +++ b/doc/building/Building.rst @@ -43,7 +43,6 @@ Here is a short comparison, so that you can choose the one you want to use: With mcode Backend <mcode/index> With LLVM Backend <llvm/index> With GCC Backend <gcc/index> - TestSuites .. HINT:: The output of both GCC and LLVM is an executable file, but `mcode` does not diff --git a/doc/building/gcc/GNULinux-GNAT.rst b/doc/building/gcc/GNULinux-GNAT.rst index f58e3b2ef..259218a82 100644 --- a/doc/building/gcc/GNULinux-GNAT.rst +++ b/doc/building/gcc/GNULinux-GNAT.rst @@ -6,13 +6,9 @@ GCC Backend on GNU/Linux with GCC/GNAT .. HINT:: There are some dependencies for building GCC (``gmp``, ``mpfr`` and ``mpc``). If you have not installed them on your system, you can either build them manually or use the ``download_prerequisites`` script provided in the GCC source tree (recommended): ``cd /path/to/gcc/source/dir && ./contrib/download_prerequisites``. * First configure GHDL, specify GCC source directory and installation prefix (like ``/usr/local`` or ``/opt/ghdl``). - * Next, invoke ``make copy-sources`` to copy GHDL sources in the source directory. - * Then, configure GCC. The list of ``--disable`` configure options can be adjusted to your needs. GHDL does not require all these optional libraries and disabling them will speed up the build. - * Now, build and install GCC with ``make``. - * Last, build and install GHDL libraries. .. rubric:: Example: diff --git a/doc/building/gcc/index.rst b/doc/building/gcc/index.rst index e579bceb8..23b6ebfa2 100644 --- a/doc/building/gcc/index.rst +++ b/doc/building/gcc/index.rst @@ -3,8 +3,6 @@ GCC Backend ########### -.. HINT:: - .. rubric:: Requirements * GCC (Gnu Compiler Collection) diff --git a/doc/getting/Releases.rst b/doc/getting/Releases.rst index 4dba31e92..f8180f0b3 100644 --- a/doc/getting/Releases.rst +++ b/doc/getting/Releases.rst @@ -108,9 +108,9 @@ later instructions or on other pages in this documentation. +----------+----------------------------------------+ | Protocol | GitHub Repository URL | +==========+========================================+ -| HTTPS | https://github.com/ghdl/ghdl.git | +| HTTPS | https://github.com/ghdl/ghdl.git | +----------+----------------------------------------+ -| SSH | ssh://git@github.com:ghdl/ghdl.git | +| SSH | ssh://git@github.com:ghdl/ghdl.git | +----------+----------------------------------------+ diff --git a/doc/index.rst b/doc/index.rst index bcbaddab3..7413f3ba6 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -27,10 +27,10 @@ LRM) is a plus. every contributor to update the remote URLs in their local clones. 14.12.2017 - `GHDL 0.35 was released <https://github.com/ghdl/ghdl/milestone/3?closed=1>`_. - ==================================== + =========================================================================================== 15.08.2017 - `GHDL 0.34 was released <https://github.com/ghdl/ghdl/milestone/1?closed=1>`_. - ==================================== + =========================================================================================== 23.10.2015 - GHDL 0.33 was released. ==================================== |