search

fkie-cad / FACT_core

Firmware Analysis and Comparison Tool
https://fkie-cad.github.io/FACT_core
GNU General Public License v3.0
1.22k stars 224 forks source link

Change sphinx theme #868

Open maringuu opened 1 year ago

maringuu commented 1 year ago

On my ubuntu 22.04 install building the docs results in the following error:

Running Sphinx v4.3.2

Warning, treated as error:
sphinx_rtd_theme (< 0.3.0) found. It will not be available since Sphinx-6.0
make: *** [Makefile:20: html] Error 2

So we should probably change the theme. Also: Did we document somewhere what dependencys building the docs has? apt install sphinx-common and pip install sphinx-rtd-theme seem to be it.

jstucke commented 1 year ago

Also: Did we document somewhere what dependencys building the docs has?

Did you try to look at the readme (/docsrc/README.md)? It should build fine if you follow the instructions :sweat_smile: Despite that, we could probably update the versions in the doc_dependencies.txt.

maringuu commented 1 year ago

Did you try to look at the readme (/docsrc/README.md)?

Whoops. No I missed that. I'd propose to add a link to it in the README.