From 6e4cd59735841521879701d67f6828d5b365ec35 Mon Sep 17 00:00:00 2001 From: umarcor Date: Mon, 6 Mar 2023 20:47:11 +0000 Subject: doc: include NEWS.md in the index --- doc/conf.py | 1 + doc/index.rst | 114 ++------------------------------------------------- doc/requirements.txt | 1 + 3 files changed, 6 insertions(+), 110 deletions(-) (limited to 'doc') diff --git a/doc/conf.py b/doc/conf.py index cc84ade50..ac56044ec 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -193,6 +193,7 @@ extensions = [ 'btd.sphinx.autoprogram', # Other extensions 'exec', + 'myst_parser', 'sphinx_fontawesome', 'sphinx_autodoc_typehints', 'autoapi.sphinx', diff --git a/doc/index.rst b/doc/index.rst index a7a69458e..0a14261d0 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -21,116 +21,10 @@ GHDL

- GHDL: free and open-source analyzer, compiler, simulator and (experimental) synthesizer for VHDL + free and open-source analyzer, compiler, simulator and (experimental) synthesizer for VHDL

-.. only:: html - - News - **** - - 2022.02.28 - `GHDL v2.0 was released `__ - ============================================================================================ - - 2021.02.02 - `GHDL v1.0 was released `__ - ============================================================================================ - - 2021.01.31 - GHDL v1.0.0rc1 was tagged - ====================================== - - * Python bindings were overhauled and renamed to ``pyGHDL``. Three modules are included: ``libghdl``, ``lsp`` and ``dom``. - - * The utility scripts in the codebase were moved into subdir ``scripts``: CI, binding generation, vendors, etc. - - * Repository `ghdl/extended-tests `__ was created for testing `vendors` build scripts. - - * The logo was updated (org, ghdl/ghdl, ghdl/docker and ghdl/ghdl-cosim). - - * Assets are not added to releases or pre-releases anymore. Users should use package managers or nightly assets. - - 2020.05.21 - Nightly build assets available - =========================================== - - * After each successful CI run of branch ``master``, packages are published as assets of pre-release `nightly `__. - * GitHub Action `ghdl/setup-ghdl-ci `__ was created, to allow easy installation of - nightly GHDL assets in GitHub Actions workflows. - - 2020.05.09 - New repositories and a wiki were created - ===================================================== - - * The plugin for Yosys was moved from `tgingold/ghdlsynth-beta `__ to - `ghdl/ghdl-yosys-plugin `__. - * Repository `ghdl/ghdl-cosim `__ was created. It contains documentation and code - examples related to VHPIDIRECT, VPI and SystemC. See :ref:`COSIM` and `Previous work and future ideas `__. - * A `Wiki `__ was created. The roadmap and ideas for documentation and internship - programs were moved there. If you want to contribute anyhow, `have a look `__! - - 2020.02.28 - `GHDL v0.37 was released `__ - ============================================================================================ - - The major changes are: - - * Experimental support of synthesis (either with --synth or with the Yosys plugin). - * Fixes and improved support of vhdl 2008. - * Last version that supports the Mentor variation of std_logic_arith. - The Synopsys one is still available. - - 2019.03.03 - `GHDL v0.36 was released `__ - ============================================================================================ - - 2019.02.23 - GHDL v0.36-rc1 was released - ======================================== - - The major improvements are: - - * more support of unbounded arrays and records - * support of UVVM and Vunit - - 2018.11.29 - GHDL 20181129 was released - ======================================= - - 2017.12.20 - A new GitHub organization was created - ================================================== - - A new GitHub organization is created and the main repo is moved from `github.com/tgingold/ghdl `__ to - `github.com/ghdl/ghdl `__. Old refs will continue working, because permanent redirects are set up. However, we suggest - every contributor to update the remote URLs in their local clones. - - 2017.12.14 - `GHDL 0.35 was released `__ - =========================================================================================== - - 2017.08.15 - `GHDL 0.34 was released `__ - =========================================================================================== - - 2015.10.23 - GHDL 0.33 was released - =================================== - -.. only:: latex - - .. rubric:: 2022.02.28 - GHDL v2.0 was released. - - .. rubric:: 2021.02.02 - GHDL v1.0 was released. - - .. rubric:: 2021.01.31 - GHDL v1.0.0rc1 was tagged. - - .. rubric:: 2020.05.21 - Nightly build assets available. - - .. rubric:: 2020.05.09 - New repositories and a wiki were created. - - .. rubric:: 2020.02.28 - GHDL v0.37 was released. - - .. rubric:: 2019.03.03 - GHDL v0.36 was released. - - .. rubric:: 2019.02.23 - GHDL v0.36-rc1 was released. - - .. rubric:: 2018.11.29 - GHDL 20181129 was released. - - .. rubric:: 2017.12.20 - A new GitHub organization was created. - - .. rubric:: 2017.12.14 - GHDL 0.35 was released. - - .. rubric:: 2017.08.15 - GHDL 0.34 was released. - - .. rubric:: 2015.10.23 - GHDL 0.33 was released. - .. include:: toc.rst + +.. include:: ../NEWS.md + :parser: myst_parser.sphinx_ diff --git a/doc/requirements.txt b/doc/requirements.txt index 494fc99b2..c9057365d 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -5,6 +5,7 @@ python-dateutil>=2.8.2 # Sphinx Extenstions autoapi>=2.0.1 +myst-parser sphinx_fontawesome>=0.0.6 sphinx_autodoc_typehints>=1.19.5 -- cgit v1.2.3