Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change docs theme to furo + upgrade docs dependencies #90

Merged
merged 13 commits into from
Apr 26, 2024
File renamed without changes
Binary file added doc/_static/images/edumfa-logo-dark.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
15 changes: 9 additions & 6 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ def wrapper(decorator):
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.imgmath', 'sphinx.ext.viewcode',
'sphinxcontrib.autohttp.flask', 'sphinxcontrib.plantuml',
'sphinxcontrib.spelling', 'sphinx.ext.todo',
'pallets_sphinx_themes']
'sphinxcontrib.spelling', 'sphinx.ext.todo', 'sphinx_copybutton',
'sphinx_inline_tabs']
http_index_ignore_prefixes = ['/token']

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -121,12 +121,15 @@ def wrapper(decorator):
#html_theme = 'sphinxdoc'
#html_theme = 'sphinx_rtd_theme'
#html_theme = 'agogo'
html_theme = 'flask'
html_theme = 'furo'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
html_theme_options = {
"light_logo": "images/edumfa-logo.png",
"dark_logo": "images/edumfa-logo-dark.png",
}

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = ['_themes/flask-sphinx-themes']
Expand All @@ -141,12 +144,12 @@ def wrapper(decorator):

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = "images/eduMFA-logo.png"
# html_logo = "images/edumfa-logo.png"

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon = "images/eduMFA-icon.png"
html_favicon = "_static/images/edumfa-icon.png"

# 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,
Expand Down
78 changes: 56 additions & 22 deletions doc/installation/ubuntu.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,33 +39,49 @@ The fingerprint of the key is::
pub rsa4096 2024-02-29 FUDIS - eduMFA APT Signing Key <fudis@fu-berlin.de>
Key fingerprint = 0578 E752 4B98 4E58 9847 139B ED01 69DB F5CD C377

On 20.04LTS you can now add the signing key to your system::
You now need to add the signing key to your system. The following instructions

apt-key add eduMFA-Release.asc
.. tab:: Ubuntu 22.04LTS

On Ubuntu 22.04LTS you can add the signing key by::
.. code-block:: bash

mv eduMFA-Release.asc /etc/apt/trusted.gpg.d/
mv eduMFA-Release.asc /etc/apt/trusted.gpg.d/eduMFA-Release.asc

Now you need to add the repository for your release (focal/20.04LTS or jammy/22.04LTS)
.. tab:: Ubuntu 20.04LTS

You can do this by running the command::
.. code-block:: bash

add-apt-repository http://bb-repo.zedat.fu-berlin.de/repository/edumfa-ubuntu-jammy
apt-key add eduMFA-Release.asc

or::
Now you need to add the repository for your release (focal/20.04LTS or jammy/22.04LTS) You can do this by running the command:

add-apt-repository http://bb-repo.zedat.fu-berlin.de/repository/edumfa-ubuntu-focal
.. tab:: Ubuntu 22.04LTS

.. code-block:: bash

add-apt-repository http://bb-repo.zedat.fu-berlin.de/repository/edumfa-ubuntu-jammy

.. tab:: Ubuntu 20.04LTS

.. code-block:: bash

add-apt-repository http://bb-repo.zedat.fu-berlin.de/repository/edumfa-ubuntu-focal

As an alternative you can add the repo in a dedicated file. Create a new
file ``/etc/apt/sources.list.d/eduMFA-community.list`` with the
following contents::
file ``/etc/apt/sources.list.d/eduMFA-community.list`` with the following contents:

.. tab:: Ubuntu 22.04LTS

.. code-block:: bash

deb http://bb-repo.zedat.fu-berlin.de/repository/edumfa-ubuntu-jammy jammy main

.. tab:: Ubuntu 20.04LTS

deb http://bb-repo.zedat.fu-berlin.de/repository/edumfa-ubuntu-jammy jammy main
.. code-block:: bash

or::
deb http://bb-repo.zedat.fu-berlin.de/repository/edumfa-ubuntu-focal focal main

deb http://bb-repo.zedat.fu-berlin.de/repository/edumfa-ubuntu-focal focal main

Installation of eduMFA 1.x
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -116,21 +132,39 @@ Clone the repository and navigate to the project directory::
git clone https://github.com/eduMFA/eduMFA.git
cd eduMFA

Choose the package you want to build based on your requirements. Use one of the following commands. This one for the core package::
Choose the packages you want to build based on your requirements. Use one of the following commands:

.. tab:: edumfa

.. code-block:: bash

cp -r deploy/ubuntu debian

.. tab:: edumfa-apache2 and edumfa-nginx

.. code-block:: bash

cp -r deploy/ubuntu-server debian

.. tab:: edumfa-radius

.. code-block:: bash

cp -r deploy/ubuntu-radius debian

cp -r deploy/ubuntu debian
Update the Linux distribution version in the changelog file:

or for apache2 and nginx package::
.. tab:: Ubuntu 22.04LTS

cp -r deploy/ubuntu-server debian
.. code-block:: bash

or for radius package::
sed -i 's/{{CODENAME}}/jammy/g' debian/changelog

cp -r deploy/ubuntu-radius debian
.. tab:: Ubuntu 20.04LTS

Update the Linux distribution version in the changelog file. For example, for Ubuntu 22.04 LTS jammy::
.. code-block:: bash

sed -i 's/{{CODENAME}}/jammy/g' debian/changelog
sed -i 's/{{CODENAME}}/focal/g' debian/changelog

Install build dependencies and build the package::

Expand Down
15 changes: 8 additions & 7 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
-r ../requirements.txt
alabaster==0.7.13
docutils==0.20.1
furo==2024.1.29
docutils==0.21.1
imagesize==1.4.1
packaging==21.3
Pallets-Sphinx-Themes==2.1.1
packaging==24.0
pyenchant==3.2.2
Pygments==2.15.0
Pygments==2.17.2
snowballstemmer==2.2.0
Sphinx==7.2.6
Sphinx==7.3.7
sphinxcontrib-applehelp==1.0.8
sphinxcontrib-devhelp==1.0.6
sphinxcontrib-htmlhelp==2.0.5
sphinxcontrib-httpdomain==1.8.1
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-plantuml==0.25
sphinxcontrib-plantuml==0.26
sphinxcontrib-qthelp==1.0.7
sphinxcontrib-serializinghtml==1.1.10
sphinxcontrib-spelling==8.0.0
sphinx-copybutton==0.5.2
sphinx-inline-tabs==2023.4.21