diff options
-rw-r--r-- | doc/appendix/Meta.rst | 16 | ||||
-rw-r--r-- | doc/helpers.py | 6 | ||||
-rw-r--r-- | doc/licenses.rst | 2 | ||||
-rw-r--r-- | doc/using/Foreign.rst | 4 |
4 files changed, 10 insertions, 18 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`. diff --git a/doc/helpers.py b/doc/helpers.py index bd8d10ad4..f30e249dc 100644 --- a/doc/helpers.py +++ b/doc/helpers.py @@ -1,3 +1,6 @@ +from os.path import dirname, join +import json + # Try to load JSON data from a file. If not found, use the argument as a tag name and retrieve the data from GitHub. def getJSON(tag='all'): f = tag @@ -6,9 +9,8 @@ def getJSON(tag='all'): f = 'releases' tag = '' - import json try: - d = json.loads(open(f+'.json', 'r').read()) + d = json.loads(open(join(dirname(__file__), f+'.json'), 'r').read()) except: from urllib.request import urlopen d = json.loads(urlopen('https://api.github.com/repos/ghdl/ghdl/releases'+tag).read()) diff --git a/doc/licenses.rst b/doc/licenses.rst index 00c5620de..9f7d17bb5 100644 --- a/doc/licenses.rst +++ b/doc/licenses.rst @@ -40,7 +40,7 @@ CC-BY-SA This is a free documentation; you can redistribute it and/or modify it under the terms of the `Creative Commons Attribution-ShareAlike 4.0 <https://creativecommons.org/licenses/by-sa/4.0/>`_ license. You are free to **share** (copy and redistribute the material in any medium or format) and/or **adapt** (remix, transform, and build upon the material for any purpose, even commercially). We cannot revoke these freedoms as long as you follow the these terms: -- **Attribution**: you must provide the name of the creator and attribution parties (`more info <https://wiki.creativecommons.org/wiki/License_Versions#Detailed_attribution_comparison_chart>`_), a copyright notice, a license notice, a disclaimer notice, a link to the material, a link to the license and indicate if changes were made (see `marking guide <https://wiki.creativecommons.org/wiki/Best_practices_for_attribution#This_is_a_good_attribution_for_material_you_modified_slightly>`_ and `more info <https://wiki.creativecommons.org/wiki/License_Versions#Modifications_and_adaptations_must_be_marked_as_such>`_). You may do so in any reasonable manner, but not in any way that suggests we endorse you or your use. +- **Attribution**: you must provide the name of the creator and attribution parties (`more info <https://wiki.creativecommons.org/wiki/License_Versions#Detailed_attribution_comparison_chart>`__), a copyright notice, a license notice, a disclaimer notice, a link to the material, a link to the license and indicate if changes were made (see `marking guide <https://wiki.creativecommons.org/wiki/Best_practices_for_attribution#This_is_a_good_attribution_for_material_you_modified_slightly>`__ and `more info <https://wiki.creativecommons.org/wiki/License_Versions#Modifications_and_adaptations_must_be_marked_as_such>`__). You may do so in any reasonable manner, but not in any way that suggests we endorse you or your use. - **ShareAlike**: if you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original. - **No additional restrictions**: you may not apply legal terms or technological measures that legally restrict others from doing anything the license permits. diff --git a/doc/using/Foreign.rst b/doc/using/Foreign.rst index 7a50e4358..0fe799943 100644 --- a/doc/using/Foreign.rst +++ b/doc/using/Foreign.rst @@ -127,7 +127,7 @@ Note the :file:`c` library is always linked with an executable. .. _Starting_a_simulation_from_a_foreign_program: Wrapping and starting a GHDL simulation from a foreign program -================================================= +============================================================== You may run your design from an external program. You just have to call the ``ghdl_main`` function which can be defined: @@ -182,7 +182,7 @@ design apex is ``design``. $ ghdl --bind design Finally, compile/bind your program and link it with your `VHDL` -design:: +design: in C: |