Merge pull request #4 from quarkslab/clean_doc

Improve documentation
quarkslab · Sep 14, 2023 · 75f035e · 75f035e
2 parents bd56bb9 + b0c34d7
commit 75f035e
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 144 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,5 +4,6 @@ idascript/
 python-bindiff/
 python-binexport/
 qbindiff/
+quokka/
 
 venv/
diff --git a/_static/style.css b/_static/style.css
@@ -1,82 +1,24 @@
 @charset "utf-8";
 
-
-.md-content dl dt {
-    font-weight: 700;
-    margin-bottom: 12px;
-}
-
-.md-content dt{
-	display: table;
-	margin: 6px 0;
-	font-size: 90%;
-	line-height: normal;
-	background: #e7f2fa;
-	/*color: #2980b9;*/
-	border-top: 3px solid #6ab0de;
-	padding: 6px;
-	position: relative
-}
-
-.md-content code, .md-content tt, code {
-    white-space: nowrap;
-    max-width: 100%;
-    background: #fff;
-    border: 1px solid #e1e4e5;
-    font-size: 75%;
-    padding: 0 5px;
-    font-family: SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;
-    color: #e74c3c;
-    overflow-x: auto;
-}
-
-
-.md-content code, .md-content tt {
-    font-family: SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;
-    padding: 2px 5px;
-}
-
-.md-content em {
-    font-style: italic;
-    color: #2980b9;
-}
-
-.md-content dl:not(.docutils)
-            dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,
-html.writer-html5 .md-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)
-dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt {
-    margin-bottom: 6px;
-    border: none;
-    border-left: 3px solid #ccc;
-    background: #f0f0f0;
-    color: #555;
-}
-
-.md-content em.property,
-.md-content em.sig-param{
-    color: #555;
+div.sphinxsidebar p.caption {
+    background: linear-gradient(90deg, rgba(232, 232, 237, 0) 0%, rgb(232, 232, 237) 17.6px, rgb(232, 232, 237) 100%);
+    font-weight: bold;
+    font-size: 15px;
 }
 
-span.sig-name.descname {
-    color: #000;
+.relbar,
+.relbar>a:hover .direction {
+    color: #7B7B7B;
 }
 
-
-html.writer-html4 .md-content dl:not(.docutils) .descclassname,
-html.writer-html4 .md-content dl:not(.docutils) .descname,
-html.writer-html4 .md-content dl:not(.docutils) .sig-name,
-html.writer-html5 .md-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,
-html.writer-html5 .md-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,
-html.writer-html5 .md-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name {
-    font-family: SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;
-    color: #000;
+.nav-icon:visited {
+    color: #E5E5E5;
 }
 
-
-.boldlink a {
-    font-weight: bold;
-    font-size: 120%;
-}
-.boldlink a > code {
-    border-width: 0px;
-}
+#topbar button:hover,
+#titlebar .buttons> :hover,
+#titlebar a:hover,
+.relbar a:hover,
+.relbar a:hover .icon {
+    color: #2D2D2D;
+}
diff --git a/conf.py b/conf.py
@@ -21,7 +21,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "Diffing Portal"
-copyright = ""
+copyright = "2023 Quarkslab"
 author = "Quarkslab"
 
 # The full version, including alpha/beta/rc tags
@@ -53,7 +53,6 @@
     "enum_tools.autoenum",
     "sphinx_fontawesome",
     "nbsphinx",
-    "sphinx_autodoc_typehints",
 ]
 
 bibtex_bibfiles = ["refs.bib"]
@@ -91,25 +90,22 @@
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
     "numpy": ("https://numpy.org/doc/stable/", None),
+    "scipy": ("https://docs.scipy.org/doc/scipy/", None),
     "networkx": ("https://networkx.org/documentation/stable/", None),
     "quokka": ("https://quarkslab.github.io/quokka/", None),
 }
 
-# autodoc_type_aliases = {
-#     "Graph": "qbindiff.GenericGraph",
-#     "qbindiff.types.Graph": "qbindiff.abstract.GenericGraph",
-#     "qbindiff.Graph": "qbindiff.abstract.GenericGraph",
-# }
+autodoc_type_aliases = {
+    "ReferenceTarget": "Data | Structure | StructureMember"
+}
 
-typehints_fully_qualified = False
 autodoc_typehints_format = "short"
 
 # -- 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_material"  #'sphinx_rtd_theme', "sphinx_book_theme"
+html_theme = "insipid"
 
 # 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,
@@ -118,62 +114,9 @@
 
 # These paths are either relative to html_static_path
 # or fully qualified paths (eg. https://...)
-html_css_files = [
-    "style.css",
-]
+html_css_files = ["style.css"]
 
 html_show_sourcelink = True
-html_sidebars = {
-    "**": [
-        "logo-text.html",
-        "globaltoc.html",
-        "localtoc.html",
-        "searchbox.html",
-    ]  # Somehow make appearing sidebar
-}
-
 
 # Set link name generated in the top bar.
 html_title = "Diffing Portal"
-
-# Material theme options (see theme.conf for more information)
-html_theme_options = {
-    "base_url": "https://quarkslab.gitlab.io/diffing-portal",
-    "repo_url": "",  # At the top right (with badges)
-    "repo_name": "Diffing Portal",
-    "google_analytics_account": "UA-XXXXX",
-    "html_minify": False,
-    "html_prettify": True,
-    "css_minify": True,
-    "logo_icon": "&#xe869",
-    "repo_type": "github",
-    "globaltoc_depth": 3,
-    "color_primary": "#4051b5",
-    "color_accent": "#d8f32a",  # "#566df3",
-    "touch_icon": "logo2.png",
-    "theme_color": "#4051b5",
-    "master_doc": False,
-    # "nav_links": [
-    #     {"href": "index", "internal": True, "title": "QBindiff++"},
-    #     {
-    #         "href": "https://squidfunk.github.io/mkdocs-material/",
-    #         "internal": False,
-    #         "title": "QBindiff--",
-    #     },
-    # ],
-    # Text written betwen top bar and nav bar
-    # "heroes": {
-    #     "index": "A responsive Material Design theme for Sphinx sites.",
-    #     "customization": "Configuration options to personalize your site.",
-    # },
-    # Versions infos
-    # "version_dropdown": False,  # Version dropdown at the top right
-    # "version_json": "_static/versions.json",
-    # "version_info": {
-    #     "Release": "https://bashtage.github.io/sphinx-material/",
-    #     "Development": "https://bashtage.github.io/sphinx-material/devel/",
-    #     "Release (rel)": "/sphinx-material/",
-    #     "Development (rel)": "/sphinx-material/devel/",
-    # },
-    "table_classes": ["plain"],
-}
diff --git a/index.rst b/index.rst
@@ -35,7 +35,7 @@ Qbindiff
 
 .. toctree::
     :caption: Qbindiff
-    :maxdepth: 2
+    :maxdepth: 3
 
     qbindiff/doc/source/intro
     qbindiff/doc/source/install

diff --git a/requirements.txt b/requirements.txt
@@ -1,5 +1,5 @@
-sphinx
-sphinx-rtd-theme
+sphinx>=7.2.4,!=7.2.5
+insipid-sphinx-theme
 myst-parser
 breathe
 sphinx_fontawesome
@@ -8,10 +8,9 @@ ipython
 sphinx-design
 sphinx-material
 sphinxcontrib-bibtex
-enum-tools[sphinx]
+#enum-tools[sphinx]  # Install manually
 quokka-project
 python-binexport
 python-bindiff
 idascript
-sphinx_autodoc_typehints
-# qbindiff
+qbindiff