aboutsummaryrefslogtreecommitdiffstats
path: root/doc/appendix/Meta.rst
diff options
context:
space:
mode:
author1138-4EB <1138-4EB@users.noreply.github.com>2019-06-25 06:09:45 +0200
committertgingold <tgingold@users.noreply.github.com>2019-06-25 06:09:45 +0200
commit5a423cc6742b02922533e9ac279677684322e655 (patch)
tree300f7976a4a48f1932642d62486ba9a7cf398d51 /doc/appendix/Meta.rst
parent8ed91011ffeeb38b725a5645e76efe3969d152c9 (diff)
downloadghdl-5a423cc6742b02922533e9ac279677684322e655.tar.gz
ghdl-5a423cc6742b02922533e9ac279677684322e655.tar.bz2
ghdl-5a423cc6742b02922533e9ac279677684322e655.zip
Fix some issues with the docs (#857)
* fix: minor doc issues * fix: doc/helpers.py
Diffstat (limited to 'doc/appendix/Meta.rst')
-rw-r--r--doc/appendix/Meta.rst16
1 files changed, 3 insertions, 13 deletions
diff --git a/doc/appendix/Meta.rst b/doc/appendix/Meta.rst
index d9a667ac4..fc4295e75 100644
--- a/doc/appendix/Meta.rst
+++ b/doc/appendix/Meta.rst
@@ -26,9 +26,9 @@ General guidelines to edit the documentation
The default role for
.. code::
-
+
``code``
-
+
is samp. ``:samp:`` is only required when you want to write italic text in code text.
.. code::
@@ -90,17 +90,7 @@ Documentation configuration
:ghdl:option:`--ieee`
:option:`ghdl:--ieee`
-CSS
-***
-
-* The indentation of the elements in the side menu have been modified. They are fixed for levels 1, 2 and 3 (`#294 <https://github.com/ghdl/ghdl/pull/294#issuecomment-281555760>`_) and 4 (later).
-
-* The RTD menu (bottom-left) has been modified (`#294 <https://github.com/ghdl/ghdl/pull/294#issuecomment-281513494>`_):
-
- * 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`.