diff options
| author | Adam Janovsky | 2022-05-01 17:30:21 +0200 |
|---|---|---|
| committer | Adam Janovsky | 2022-05-01 17:30:21 +0200 |
| commit | d4760ca46ace74c48e27a383058cc8219c4ab2a5 (patch) | |
| tree | 4f928e26e5d62e4c10949a936840b2d2d75fa2ca | |
| parent | e05e66bc8c9230e704e8aa4332a92727a18c68dc (diff) | |
| download | sec-certs-d4760ca46ace74c48e27a383058cc8219c4ab2a5.tar.gz sec-certs-d4760ca46ace74c48e27a383058cc8219c4ab2a5.tar.zst sec-certs-d4760ca46ace74c48e27a383058cc8219c4ab2a5.zip | |
docs: don't show whole version, add navigation
| -rw-r--r-- | docs/conf.py | 3 | ||||
| -rw-r--r-- | docs/index.md | 8 |
2 files changed, 9 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py index 701f4924..c7f4c6ff 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,9 +21,8 @@ project = "sec-certs" copyright = "2022, Adam Janovsky, Petr Svenda, Jan Jancar, Jiri Michalik, Stanislav Bobon" author = "Adam Janovsky, Petr Svenda, Jan Jancar, Jiri Michalik, Stanislav Bobon" -# The full version, including alpha/beta/rc tags # Note thas this inference won't work from Docker: https://github.com/pypa/setuptools_scm/#usage-from-docker -release = get_version("sec-certs") +release = ".".join(get_version("sec-certs").split(".")[:3]) # -- General configuration --------------------------------------------------- diff --git a/docs/index.md b/docs/index.md index dd7c9e53..084f7d08 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,6 +3,14 @@ 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} +:hidden: +:caption: Navigation +Seccerts homepage <https://seccerts.org/> +Seccerts docs <https://seccerts.org/docs> +GitHub repo <https://github.com/crocs-muni/sec-certs> +``` + +```{toctree} :caption: User's guide installation.md quickstart.md |