Skip to content

Commit

Permalink
Restructure docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
antarcticrainforest committed Feb 25, 2024
1 parent 2873f06 commit 81b06ab
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/architecture/Architecture.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Deployment Architecture
# Freva Architecture


The Free evaluation system framework (Freva) consists of three basic parts:
Expand Down
4 changes: 2 additions & 2 deletions docs/architecture/Folders.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Primer: Basic Freva configuration
# Basic Freva configuration

Because the framework consists of multiple parts, Freva has to be configured
to work with those different parts. This is especially true for the web ui
Expand All @@ -14,7 +14,7 @@ is important for the interplay of the `evaluation_system` core and the web ui.
The content of the initial `evaluation_system.conf` file looks like the
following:

```
```ini
[evaluation_system]
# Freva - Free Evaluation System Framework configuration file
# This file contains the necessary configuration information
Expand Down
4 changes: 2 additions & 2 deletions docs/architecture/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Freva structure overview
========================
Freva from an admin perspective
===============================

This chapter gives an overview of how freva works and a working freva deployment
is configured. Read the section in this chapter carefully to understand
Expand Down
4 changes: 1 addition & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,9 @@
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.napoleon",
"nbsphinx",
"recommonmark",
"sphinx.ext.viewcode",
"sphinxcontrib_github_alt",
"sphinx_copybutton",
"sphinx_togglebutton",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
12 changes: 6 additions & 6 deletions src/freva_deployment/keys.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
from tempfile import TemporaryDirectory
from typing import Optional

from cryptography import x509
from cryptography.hazmat.backends import default_backend
from cryptography.hazmat.primitives import hashes, serialization
from cryptography.hazmat.primitives.asymmetric import rsa
from cryptography.x509 import Name, NameAttribute
from cryptography.x509.oid import NameOID
#from cryptography import x509
#from cryptography.hazmat.backends import default_backend
#from cryptography.hazmat.primitives import hashes, serialization
#from cryptography.hazmat.primitives.asymmetric import rsa
#from cryptography.x509 import Name, NameAttribute
#from cryptography.x509.oid import NameOID


class RandomKeys:
Expand Down

0 comments on commit 81b06ab

Please sign in to comment.