From 64a965c3dee2cec9d8f5ccfdd401e71df9f90e31 Mon Sep 17 00:00:00 2001 From: Pierrot Date: Thu, 27 Jul 2023 16:01:08 +0200 Subject: [PATCH] Clean up documentation (#765) * Keep the default width of the rtd-theme * Improve conf.py * Clarify input file formats * Fix spelling * Review changes * Doublon * Revert removing _static directory --- docs/sphinx_docs/Input_file_formats/index.rst | 15 +++++++++++---- docs/sphinx_docs/_static/.gitkeep | 0 docs/sphinx_docs/_static/css/dac_theme_modif.css | 8 -------- docs/sphinx_docs/conf.py | 9 +++------ 4 files changed, 14 insertions(+), 18 deletions(-) create mode 100644 docs/sphinx_docs/_static/.gitkeep delete mode 100644 docs/sphinx_docs/_static/css/dac_theme_modif.css diff --git a/docs/sphinx_docs/Input_file_formats/index.rst b/docs/sphinx_docs/Input_file_formats/index.rst index 5d88d04ed..5a4c44ca8 100644 --- a/docs/sphinx_docs/Input_file_formats/index.rst +++ b/docs/sphinx_docs/Input_file_formats/index.rst @@ -3,11 +3,18 @@ Input file formats ****************** -Alt-ergo supports different input language. The main language is his native language, based on the lamguage of the Why plateform and detailed below. Alt-ergo (partially) supports the standard language of the SMT community, SMT-LIB. It also (partially) supports the input language of Why3 through the :doc:`AB-Why3 plugin <../Plugins/ab_why3>`. +Alt-ergo supports different input languages: + +- The original input language is its native language, based on the language of the Why3 platform and + detailed below. +- Alt-ergo supports the SMT-LIB language v2.6. Since 2.5.0, improved support + is provided by the `Dolmen `_ frontend, available with + the `--frontend dolmen` option. +- It also (partially) supports the input language of Why3 through the :doc:`AB-Why3 plugin <../Plugins/ab_why3>`. .. toctree:: :maxdepth: 2 :caption: Contents - - Alt-Ergo's native language - SMT-LIB + + Alt-Ergo's native language + SMT-LIB 2 diff --git a/docs/sphinx_docs/_static/.gitkeep b/docs/sphinx_docs/_static/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/docs/sphinx_docs/_static/css/dac_theme_modif.css b/docs/sphinx_docs/_static/css/dac_theme_modif.css deleted file mode 100644 index ba4584a84..000000000 --- a/docs/sphinx_docs/_static/css/dac_theme_modif.css +++ /dev/null @@ -1,8 +0,0 @@ -/* Theme modification for the documentation included in Try-Alt-Ergo (Doc-Alt-Ergo). - * The original theme is sphinx_rtd_theme - */ - -/* Used for larger body */ -.wy-nav-content { - max-width: 1200px !important; -} diff --git a/docs/sphinx_docs/conf.py b/docs/sphinx_docs/conf.py index 3ee83db4a..cf504c2a3 100644 --- a/docs/sphinx_docs/conf.py +++ b/docs/sphinx_docs/conf.py @@ -17,9 +17,9 @@ # -- Project information ----------------------------------------------------- -project = 'Doc-Alt-Ergo' -copyright = '2020 - 2023, Alt-Ergo devs' -author = 'Alt-Ergo devs' +project = 'Alt-Ergo Documentation' +copyright = '2020 - 2023, Alt-Ergo developers' +author = 'Alt-Ergo developers' # -- Entry point ------------------------------------------------------------- @@ -56,9 +56,6 @@ html_show_sourcelink = False -def setup(app): - app.add_css_file('css/dac_theme_modif.css') - # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css".