diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 4ec53bfb1..741ba7f50 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -16,7 +16,7 @@ jobs: - name: Setup and build run: | sudo apt-get install python3-pip - pip3 install sphinx sphinx-vhdl sphinx_rtd_theme piccolo_theme GitPython + pip3 install sphinx sphinx-vhdl sphinx_rtd_theme furo GitPython mkdir public mkdir public/html cp doc/source/index.html public/html/ diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 3e1bed62b..7b190af8a 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -16,7 +16,7 @@ pages: - apk add git - pip install -U GitPython - pip install -U sphinx - - pip install -U piccolo_theme + - pip install -U furo - pip install -U sphinx-vhdl - echo "Hotfix detached head, causing trouble in GitPython:" - git checkout $CI_COMMIT_BRANCH diff --git a/README.md b/README.md index 55327c80c..fdaf283da 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ First, you need to install a few Python packages: $ pip3 install --user GitPython $ pip3 install --user sphinx $ pip3 install --user sphinx-vhdl -$ pip3 install --user piccolo_theme +$ pip3 install --user furo ``` Then the documentation is generated simply by issuing these two commands: diff --git a/doc/source/_templates/layout.html b/doc/source/_templates/layout.html deleted file mode 100644 index f318c80fc..000000000 --- a/doc/source/_templates/layout.html +++ /dev/null @@ -1,115 +0,0 @@ -{% extends "basic/layout.html" %} {%- block body_tag %} -
- {% endblock %} {%- block header %} - - - {% endblock %} {%- block sidebar1 %} {{ sidebar() }} {%- block sidebarlogo - %}{% endblock %} {% endblock %} {%- block sidebar2 %} {% if display_toc %} - - - - {% endif %} {% endblock %} {%- block relbar1 %}{% endblock %} {%- block - scripts %} {{- script() }} - - - {%- endblock %} {%- block relbar2 %} - - {% endblock %} {%- block footer %} {{ super() }} -- {% if theme_show_theme_credit %}Styled using the - Piccolo Theme{% endif %} -
- {%- endblock %} - diff --git a/doc/source/_templates/page.html b/doc/source/_templates/page.html new file mode 100644 index 000000000..a4b0937bb --- /dev/null +++ b/doc/source/_templates/page.html @@ -0,0 +1,297 @@ +{% extends "base.html" %} {% block body -%} {{ super() }} {% include +"partials/icons.html" %} + + + + + + + + {%- trans -%} Skip to content {%- endtrans -%} + + +{% if theme_announcement -%} +