diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml deleted file mode 100644 index 67692009..00000000 --- a/.github/workflows/documentation.yml +++ /dev/null @@ -1,27 +0,0 @@ -name: documentation - -on: [push, pull_request, workflow_dispatch] - -permissions: - contents: write - -jobs: - docs: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 - - name: Install dependencies - run: | - pip install sphinx sphinx_rtd_theme myst_parser - - name: Sphinx build - run: | - sphinx-build docs _build - - name: Deploy to GitHub Pages - uses: peaceiris/actions-gh-pages@v3 - if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/sphinx-documentation') }} - with: - publish_branch: gh-pages - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: _build/ - force_orphan: true \ No newline at end of file diff --git a/README.md b/README.md index baecd65a..80f640d8 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ MAL ([Meta Attack Language](https://mal-lang.org/)) models and attack graphs. Attack graphs can be used to run simulations in [MAL Simulator](https://github.com/mal-lang/mal-simulator) or run your own custom analysis on. -- [MAL Toolbox Documentation](https://github.com/mal-lang/mal-toolbox/wiki) +- [MAL Toolbox Wiki](https://github.com/mal-lang/mal-toolbox/wiki) - [MAL Toolbox tutorial](https://github.com/mal-lang/mal-toolbox-tutorial) # Usage diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index c4340744..00000000 --- a/docs/.gitignore +++ /dev/null @@ -1 +0,0 @@ -_* \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 936fa150..00000000 --- a/docs/Makefile +++ /dev/null @@ -1,21 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -SOURCEDIR = . -BUILDDIR = _build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - sphinx-apidoc --no-toc --module-first --force --separate -o ./apidocs ../maltoolbox/ - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/about.rst b/docs/about.rst deleted file mode 100644 index 013111e7..00000000 --- a/docs/about.rst +++ /dev/null @@ -1,16 +0,0 @@ -About MAL Toolbox -================= - -MAL Toolbox is a collection of tools related to MAL (`Meta Attack Language `_). -It can be used to load or create models and generate attack graphs from MAL languages. -Attack graphs can be used to run simulations (see `MAL Simulator `_) or analysis. - -.. toctree:: - :maxdepth: 5 - :caption: About MAL Toolbox concepts: - - about/languagegraph - - about/model - - about/attackgraph diff --git a/docs/about/attackgraph.rst b/docs/about/attackgraph.rst deleted file mode 100644 index 8b409c3e..00000000 --- a/docs/about/attackgraph.rst +++ /dev/null @@ -1,100 +0,0 @@ -AttackGraph ------------ - -From a Model it is possible to create an :class:`maltoolbox.attackgraph.AttackGraph`. - -The point of the AttackGraph is to give an abstraction that shows each step an attacker can take, analyze -paths for an attacker and run simulations. - -While a Model consists of assets and associations, an AttackGraph instead contains :class:`maltoolbox.attackgraph.AttackGraphNode`. -The AttackGraphNode can be an attack or defense step (defined in the MAL language for each type of asset). - -AttackGraphNode -"""""""""""""""" -An AttackGraphNode is an attack step or a defense step, decided by its type. -If the node has type `and` or `or`, it is considered an attack step. - -Nodes can have these properties: - -* Viable - - Determine if a node can be traversed under any circumstances or - if the model structure or active defense steps makes it unviable. -* Necessary - - Determine if a node is necessary for the attacker or if the - model structure means it is not needed(it behaves as if it were already - compromised) to compromise children attack steps. -* Compromised - - An attacker compromises an attack step by reaching it (performing the attack step) -* Traversable - - Determines whether an attack step can be compromised in the next step. -* Reachable - - Determines if a specific or any attacker can reach an attack step any time in the future from its currently reached attack steps. - -Generating an AttackGraph -""""""""""""""""""""""""" - -If you already have an instance model file and .mal/.mar, the easiest way to create an AttackGraph -is to use the wrapper :func:`maltoolbox.attackgraph.create_attack_graph` -which combines all steps from model file to the AttackGraph: - -.. code-block:: python - - from maltoolbox.attackgraph import create_attack_graph - - lang_file = "org.mal-lang.coreLang-1.0.0.mar" - model_file = "example-model.yml" - attack_graph = create_attack_graph(lang_file, model_file) - - -To generate an AttackGraph from existing lang graph and model, use the init of -:func:`maltoolbox.attackgraph.attackgraph.AttackGraph`: - -.. code-block:: python - - # Create the attack graph from existing LanguageGraph and Model - attack_graph = AttackGraph(lang_graph, model) - -From AttackGraph file :func:`maltoolbox.attackgraph.attackgraph.AttackGraph.load_from_file`: - -.. code-block:: python - - from maltoolbox.attackgraph import AttackGraph - - # Load the attack graph - example_graph_path = "attackgraph.yml" - loaded_attack_graph = AttackGraph.load_from_file(example_graph_path) - -Analyzers -""""""""" - -:mod:`maltoolbox.attackgraph.analyzers` contains analyzers for the attackgraph used to calculate viability and necessity. - - -Pattern matching -"""""""""""""""" - -:mod:`maltoolbox.patternfinder.attack_graph_patterns` contains a regex-like feature to search for patterns in an attack graph. - -Example: - -.. code-block:: python - - attack_graph: AttackGraph - - # Create the search pattern to find paths from Node1 to any node - pattern = SearchPattern( - [ - SearchCondition( - lambda node: node.name == "Node1" - ), - SearchCondition( - SearchCondition.ANY - ), - SearchCondition( - lambda node: node.name == "Node4" - ) - ] - ) - - # Returns a list of node paths that match - paths = pattern.find_matches(attack_graph) diff --git a/docs/about/languagegraph.rst b/docs/about/languagegraph.rst deleted file mode 100644 index 589fbc08..00000000 --- a/docs/about/languagegraph.rst +++ /dev/null @@ -1,17 +0,0 @@ -LanguageGraph -------------- - -The :class:`maltoolbox.language.languagegraph.LanguageGraph` contains a graph representation of the MAL language that is loaded. -`Read more about MAL `_. - -It will also contain a language specification which is a dict containing the language (asset types, association types and attack steps). - -Load a LanguageGraph -"""""""""""""""""""" - -.. code-block:: python - - from maltoolbox.language import LanguageGraph - - # Will load the MAL language (.mal/.mar) or a saved language graph (yml/json) - lang_graph = LanguageGraph.load_from_file(lang_file_path) diff --git a/docs/about/model.rst b/docs/about/model.rst deleted file mode 100644 index f5d147eb..00000000 --- a/docs/about/model.rst +++ /dev/null @@ -1,125 +0,0 @@ - -Model ------ - -With a MAL language (e.g. `coreLang `_) defined in a .mar or .mal-file, -a :class:`maltoolbox.model.Model` can be created either from a model instance file or empty. - -Assets and associations -""""""""""""""""""""""" -A model consists of assets and associations. - -- An asset is an instance of an asset type (LanguageGraphAsset) - -- An association is a relation between two or more assets (an instance of a LanugageGraphAssociation) - -The MAL language defines which assets can have an association between each other and what the 'field names' between them are called. - -Example: -`Application` is an asset type defined in the MAL Language coreLang. The association `AppExecution` is defined in coreLang. -It can exist between `Application` and `Application` through field names `hostApp` and `appExecutedApps`, -this is defined in the MAL language coreLang but can look different in other MAL languages. - -Load/create a model -""""""""""""""""""" - -With the MAL GUI -'''''''''''''''' - -You can use the `MAL GUI `_ to create models. -This is a program that lets you drag and drop assets and associations given that you have a MAL language define already. -It will output model files. - -In Python code -'''''''''''''' - -First, you have to load the MAL language: - -.. code-block:: python - - from maltoolbox.language import LanguageGraph - - # First load the language either from .mal / .mar / .yml / .json - lang_graph = LanguageGraph.load_from_file(lang_file_path) - -With existing model instance file -(`see example `_): - -.. code-block:: python - - from maltoolbox.model import Model - - # Load the model (i.e. the simple_example_model.json, can also be .yml/yaml) - model_file_path = "example_model.yml" - instance_model = Model.load_from_file(model_file_path, lang_graph) - -Without existing model instance file: - -.. code-block:: python - - from maltoolbox.model import Model - - # Create an empty model - instance_model = Model("Example Model", lang_graph) - - # Create and add assets of type supported by the MAL language - asset1 = instance_model.add_asset('Application', 'Application1') - asset2 = instance_model.add_asset('Application', 'Application2') - - # Create association between the assets - asset1.add_associated_assets('appExecutedApps', asset2) - -For more info on how to use MAL Toolbox, -`Read the tutorial docs `_. - -The instance model file -"""""""""""""""""""""""" - -The model file contains `metadata`, `assets`, and optionally `attackers`. -It is NOT suggested to add attackers to model files since this will be deprecated. - -- `metadata` is to keep track on the version of toolbox and the language was used. - -- `assets` contain all the assets in your instance model. - -- `attackers` contain attackers entrypoints (If you plan to run simulations, please use the scenario file -instead of the model file to define entrypoints) - - -.. code-block:: yml - metadata: - MAL-Toolbox Version: 1.1.0 - info: Created by the mal-toolbox model python module. - langID: org.mal-lang.tyrLang - langVersion: 0.0.8 - malVersion: 0.1.0-SNAPSHOT - name: Demo Model - - assets: - 0: - associated_assets: - vulnerabilities: - 1: SW Vuln - ap01 - name: ap01 - type: Application - - attackers: {} - - -Change defense status -'''''''''''''''''''''' - -To change defenses `enabled`-status in the model file, use the `defenses` keyword of model assets: - -Example: - -.. code-block:: yml - assets: - 0: - associated_assets: - vulnerabilities: - 1: SW Vuln - ap01 - defenses: - notPresent: 1.0 # Will enable defense 'notPresent' - name: ap01 - type: Application diff --git a/docs/apidocs/maltoolbox.attackgraph.analyzers.apriori.rst b/docs/apidocs/maltoolbox.attackgraph.analyzers.apriori.rst deleted file mode 100644 index fccd8492..00000000 --- a/docs/apidocs/maltoolbox.attackgraph.analyzers.apriori.rst +++ /dev/null @@ -1,7 +0,0 @@ -maltoolbox.attackgraph.analyzers.apriori module -=============================================== - -.. automodule:: maltoolbox.attackgraph.analyzers.apriori - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/apidocs/maltoolbox.attackgraph.analyzers.rst b/docs/apidocs/maltoolbox.attackgraph.analyzers.rst deleted file mode 100644 index 1c87c1f5..00000000 --- a/docs/apidocs/maltoolbox.attackgraph.analyzers.rst +++ /dev/null @@ -1,15 +0,0 @@ -maltoolbox.attackgraph.analyzers package -======================================== - -.. automodule:: maltoolbox.attackgraph.analyzers - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - maltoolbox.attackgraph.analyzers.apriori diff --git a/docs/apidocs/maltoolbox.attackgraph.attacker.rst b/docs/apidocs/maltoolbox.attackgraph.attacker.rst deleted file mode 100644 index f7bb6512..00000000 --- a/docs/apidocs/maltoolbox.attackgraph.attacker.rst +++ /dev/null @@ -1,7 +0,0 @@ -maltoolbox.attackgraph.attacker module -====================================== - -.. automodule:: maltoolbox.attackgraph.attacker - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/apidocs/maltoolbox.attackgraph.attackgraph.rst b/docs/apidocs/maltoolbox.attackgraph.attackgraph.rst deleted file mode 100644 index 1b84958a..00000000 --- a/docs/apidocs/maltoolbox.attackgraph.attackgraph.rst +++ /dev/null @@ -1,7 +0,0 @@ -maltoolbox.attackgraph.attackgraph module -========================================= - -.. automodule:: maltoolbox.attackgraph.attackgraph - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/apidocs/maltoolbox.attackgraph.node.rst b/docs/apidocs/maltoolbox.attackgraph.node.rst deleted file mode 100644 index 7c1f13a1..00000000 --- a/docs/apidocs/maltoolbox.attackgraph.node.rst +++ /dev/null @@ -1,7 +0,0 @@ -maltoolbox.attackgraph.node module -================================== - -.. automodule:: maltoolbox.attackgraph.node - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/apidocs/maltoolbox.attackgraph.query.rst b/docs/apidocs/maltoolbox.attackgraph.query.rst deleted file mode 100644 index 8b213b7c..00000000 --- a/docs/apidocs/maltoolbox.attackgraph.query.rst +++ /dev/null @@ -1,7 +0,0 @@ -maltoolbox.attackgraph.query module -=================================== - -.. automodule:: maltoolbox.attackgraph.query - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/apidocs/maltoolbox.attackgraph.rst b/docs/apidocs/maltoolbox.attackgraph.rst deleted file mode 100644 index 73a55b09..00000000 --- a/docs/apidocs/maltoolbox.attackgraph.rst +++ /dev/null @@ -1,26 +0,0 @@ -maltoolbox.attackgraph package -============================== - -.. automodule:: maltoolbox.attackgraph - :members: - :undoc-members: - :show-inheritance: - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - maltoolbox.attackgraph.analyzers - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - maltoolbox.attackgraph.attacker - maltoolbox.attackgraph.attackgraph - maltoolbox.attackgraph.node - maltoolbox.attackgraph.query diff --git a/docs/apidocs/maltoolbox.exceptions.rst b/docs/apidocs/maltoolbox.exceptions.rst deleted file mode 100644 index e0254bfa..00000000 --- a/docs/apidocs/maltoolbox.exceptions.rst +++ /dev/null @@ -1,7 +0,0 @@ -maltoolbox.exceptions module -============================ - -.. automodule:: maltoolbox.exceptions - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/apidocs/maltoolbox.file_utils.rst b/docs/apidocs/maltoolbox.file_utils.rst deleted file mode 100644 index 0448848a..00000000 --- a/docs/apidocs/maltoolbox.file_utils.rst +++ /dev/null @@ -1,7 +0,0 @@ -maltoolbox.file\_utils module -============================= - -.. automodule:: maltoolbox.file_utils - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/apidocs/maltoolbox.ingestors.rst b/docs/apidocs/maltoolbox.ingestors.rst deleted file mode 100644 index ffa52602..00000000 --- a/docs/apidocs/maltoolbox.ingestors.rst +++ /dev/null @@ -1,8 +0,0 @@ -maltoolbox.ingestors package -============================ - -.. automodule:: maltoolbox.ingestors - :members: - :undoc-members: - :show-inheritance: - diff --git a/docs/apidocs/maltoolbox.language.compiler.mal_lexer.rst b/docs/apidocs/maltoolbox.language.compiler.mal_lexer.rst deleted file mode 100644 index 7e03c2e9..00000000 --- a/docs/apidocs/maltoolbox.language.compiler.mal_lexer.rst +++ /dev/null @@ -1,7 +0,0 @@ -maltoolbox.language.compiler.mal\_lexer module -============================================== - -.. automodule:: maltoolbox.language.compiler.mal_lexer - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/apidocs/maltoolbox.language.compiler.mal_parser.rst b/docs/apidocs/maltoolbox.language.compiler.mal_parser.rst deleted file mode 100644 index c0826850..00000000 --- a/docs/apidocs/maltoolbox.language.compiler.mal_parser.rst +++ /dev/null @@ -1,7 +0,0 @@ -maltoolbox.language.compiler.mal\_parser module -=============================================== - -.. automodule:: maltoolbox.language.compiler.mal_parser - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/apidocs/maltoolbox.language.compiler.mal_visitor.rst b/docs/apidocs/maltoolbox.language.compiler.mal_visitor.rst deleted file mode 100644 index d7aad9c5..00000000 --- a/docs/apidocs/maltoolbox.language.compiler.mal_visitor.rst +++ /dev/null @@ -1,7 +0,0 @@ -maltoolbox.language.compiler.mal\_visitor module -================================================ - -.. automodule:: maltoolbox.language.compiler.mal_visitor - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/apidocs/maltoolbox.language.compiler.rst b/docs/apidocs/maltoolbox.language.compiler.rst deleted file mode 100644 index 0f7d5cac..00000000 --- a/docs/apidocs/maltoolbox.language.compiler.rst +++ /dev/null @@ -1,17 +0,0 @@ -maltoolbox.language.compiler package -==================================== - -.. automodule:: maltoolbox.language.compiler - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - maltoolbox.language.compiler.mal_lexer - maltoolbox.language.compiler.mal_parser - maltoolbox.language.compiler.mal_visitor diff --git a/docs/apidocs/maltoolbox.language.languagegraph.rst b/docs/apidocs/maltoolbox.language.languagegraph.rst deleted file mode 100644 index 0d0a1bf7..00000000 --- a/docs/apidocs/maltoolbox.language.languagegraph.rst +++ /dev/null @@ -1,7 +0,0 @@ -maltoolbox.language.languagegraph module -======================================== - -.. automodule:: maltoolbox.language.languagegraph - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/apidocs/maltoolbox.language.rst b/docs/apidocs/maltoolbox.language.rst deleted file mode 100644 index 5bad4616..00000000 --- a/docs/apidocs/maltoolbox.language.rst +++ /dev/null @@ -1,23 +0,0 @@ -maltoolbox.language package -=========================== - -.. automodule:: maltoolbox.language - :members: - :undoc-members: - :show-inheritance: - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - maltoolbox.language.compiler - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - maltoolbox.language.languagegraph diff --git a/docs/apidocs/maltoolbox.language.specification.rst b/docs/apidocs/maltoolbox.language.specification.rst deleted file mode 100644 index c46e9069..00000000 --- a/docs/apidocs/maltoolbox.language.specification.rst +++ /dev/null @@ -1,7 +0,0 @@ -maltoolbox.language.specification module -======================================== - -.. automodule:: maltoolbox.language.specification - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/apidocs/maltoolbox.model.rst b/docs/apidocs/maltoolbox.model.rst deleted file mode 100644 index 45d85b83..00000000 --- a/docs/apidocs/maltoolbox.model.rst +++ /dev/null @@ -1,7 +0,0 @@ -maltoolbox.model module -======================= - -.. automodule:: maltoolbox.model - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/apidocs/maltoolbox.patternfinder.attackgraph_patterns.rst b/docs/apidocs/maltoolbox.patternfinder.attackgraph_patterns.rst deleted file mode 100644 index 6acbcb33..00000000 --- a/docs/apidocs/maltoolbox.patternfinder.attackgraph_patterns.rst +++ /dev/null @@ -1,7 +0,0 @@ -maltoolbox.patternfinder.attackgraph\_patterns module -===================================================== - -.. automodule:: maltoolbox.patternfinder.attackgraph_patterns - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/apidocs/maltoolbox.patternfinder.rst b/docs/apidocs/maltoolbox.patternfinder.rst deleted file mode 100644 index fe3857db..00000000 --- a/docs/apidocs/maltoolbox.patternfinder.rst +++ /dev/null @@ -1,15 +0,0 @@ -maltoolbox.patternfinder package -================================ - -.. automodule:: maltoolbox.patternfinder - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - maltoolbox.patternfinder.attackgraph_patterns diff --git a/docs/apidocs/maltoolbox.rst b/docs/apidocs/maltoolbox.rst deleted file mode 100644 index b0973bf8..00000000 --- a/docs/apidocs/maltoolbox.rst +++ /dev/null @@ -1,30 +0,0 @@ -maltoolbox package -================== - -.. automodule:: maltoolbox - :members: - :undoc-members: - :show-inheritance: - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - maltoolbox.attackgraph - maltoolbox.ingestors - maltoolbox.language - maltoolbox.patternfinder - maltoolbox.translators - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - maltoolbox.exceptions - maltoolbox.file_utils - maltoolbox.model - maltoolbox.wrappers diff --git a/docs/apidocs/maltoolbox.translators.rst b/docs/apidocs/maltoolbox.translators.rst deleted file mode 100644 index db9cf9fb..00000000 --- a/docs/apidocs/maltoolbox.translators.rst +++ /dev/null @@ -1,16 +0,0 @@ -maltoolbox.translators package -============================== - -.. automodule:: maltoolbox.translators - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - maltoolbox.translators.securicad - maltoolbox.translators.updater diff --git a/docs/apidocs/maltoolbox.translators.securicad.rst b/docs/apidocs/maltoolbox.translators.securicad.rst deleted file mode 100644 index 5ad718ce..00000000 --- a/docs/apidocs/maltoolbox.translators.securicad.rst +++ /dev/null @@ -1,7 +0,0 @@ -maltoolbox.translators.securicad module -======================================= - -.. automodule:: maltoolbox.translators.securicad - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/apidocs/maltoolbox.translators.updater.rst b/docs/apidocs/maltoolbox.translators.updater.rst deleted file mode 100644 index 9d655758..00000000 --- a/docs/apidocs/maltoolbox.translators.updater.rst +++ /dev/null @@ -1,7 +0,0 @@ -maltoolbox.translators.updater module -===================================== - -.. automodule:: maltoolbox.translators.updater - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/apidocs/maltoolbox.wrappers.rst b/docs/apidocs/maltoolbox.wrappers.rst deleted file mode 100644 index f593b766..00000000 --- a/docs/apidocs/maltoolbox.wrappers.rst +++ /dev/null @@ -1,7 +0,0 @@ -maltoolbox.wrappers module -========================== - -.. automodule:: maltoolbox.wrappers - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 3db6887f..00000000 --- a/docs/conf.py +++ /dev/null @@ -1,58 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -import os -import sys - -sys.path.insert(0, os.path.abspath('../')) # Source code dir relative to this file - - -# -- Project information ----------------------------------------------------- - -project = 'MAL Toolbox' -copyright = '2024, Andrei Buhaiu, Giuseppe Nebbione, Nikolaos Kakouros, Jakob Nyberg, Joakim Loxdal' -author = 'Andrei Buhaiu, Giuseppe Nebbione, Nikolaos Kakouros, Jakob Nyberg, Joakim Loxdal' - - -# -- General configuration --------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'sphinx.ext.viewcode', - 'sphinx.ext.napoleon', - 'sphinx.ext.autodoc', # Core library for html generation from docstrings - 'sphinx.ext.autosummary', # Create neat summary tables -] -autosummary_generate = True # Turn on sphinx.ext.autosummary - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = 'sphinx_rtd_theme' # pip install sphinx_rtd_theme - -# 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, -# so a file named "default.css" will overwrite the builtin "default.css". -# html_static_path = ['_static'] diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 0997504e..00000000 --- a/docs/index.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. MAL Toolbox documentation master file, created by - sphinx-quickstart on Tue May 14 10:41:21 2024. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to MAL Toolbox's documentation! -======================================= - -.. toctree:: - :maxdepth: 5 - :caption: Contents: - - about - - installation - - API documentation - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/installation.rst b/docs/installation.rst deleted file mode 100644 index 1561469c..00000000 --- a/docs/installation.rst +++ /dev/null @@ -1,4 +0,0 @@ -Installation -============ - -`Read the tutorial `_ \ No newline at end of file