diff options
| author | Adam Janovsky | 2022-05-01 17:06:37 +0200 |
|---|---|---|
| committer | Adam Janovsky | 2022-05-01 17:06:37 +0200 |
| commit | e05e66bc8c9230e704e8aa4332a92727a18c68dc (patch) | |
| tree | 3de9b8ebb96324bed121f7d86e892be268b407a1 /docs | |
| parent | 8031a46c38f20f624a384e2a69da2ff775c86470 (diff) | |
| download | sec-certs-e05e66bc8c9230e704e8aa4332a92727a18c68dc.tar.gz sec-certs-e05e66bc8c9230e704e8aa4332a92727a18c68dc.tar.zst sec-certs-e05e66bc8c9230e704e8aa4332a92727a18c68dc.zip | |
docs: add favicon and logo
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 3 | ||||
| -rw-r--r-- | docs/index.md | 2 |
2 files changed, 3 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py index b821cd0a..701f4924 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -52,3 +52,6 @@ html_theme = "sphinx_book_theme" # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] + +html_logo = "_static/logo.svg" +html_favicon = "_static/logo_badge.svg" diff --git a/docs/index.md b/docs/index.md index 5b390b63..dd7c9e53 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,5 @@ # Sec-certs documentation - - There are three main parts of this documentation. *User's guide* describes high-level use of our tool. Driven by this knowledge, you can progress to *Notebook examples* that showcase most of the API that we use in the form of Jupyter notebooks. The documentation currently does not have all modules documented with `autodoc`, so for the API reference, you must directly inspect the [sec_certs](https://github.com/crocs-muni/sec-certs/tree/main/sec_certs) module. If you want, you can run the notebooks as they are stored in the [project repository](https://github.com/crocs-muni/sec-certs/tree/main/notebooks). If you are interested in contributing to our project or in other aspects of our development, you can consult the relevant *GitHub artifacts* ```{toctree} |