Merge pull request #29 from ayasyrev/renames

Renames

Author: ayasyrev

docs/overrides/partials/copyright.html

@@ -1,6 +1,3 @@
-{#-
-  This file was automatically generated - do not edit
--#}
 <div class="md-copyright">
   {% if config.copyright %}
     <div class="md-copyright__highlight">

mkdocs.yaml

@@ -19,4 +19,5 @@ theme:
 markdown_extensions:
   - admonition
   - pymdownx.details
-  - pymdownx.superfences
+  - pymdownx.superfences
+copyright: Copyright © 2022-2023 Andrei Yasyrev.

src/nbdocs/apps/app_nb2md.py

@@ -8,7 +8,7 @@
 
 from nbdocs.convert import convert2md, filter_changed
 from nbdocs.core import get_nb_names
-from nbdocs.settings import get_config
+from nbdocs.cfg_tools import get_config
 
 
 parser_cfg = ArgumentParserCfg(description="Nb2Md. Convert notebooks to Markdown.")
@@ -55,7 +55,9 @@ def convert(
     rprint(f"Found {nbs_number} notebooks.")
 
     cfg = get_config(
-        notebooks_path=app_cfg.nb_path, docs_path=app_cfg.dest_path, images_path=app_cfg.images_path
+        notebooks_path=app_cfg.nb_path,
+        docs_path=app_cfg.dest_path,
+        images_path=app_cfg.images_path,
     )
 
     # check logic -> do we need subdir and how to check modified Nbs

src/nbdocs/apps/app_nbclean.py

@@ -7,7 +7,7 @@
 
 from nbdocs.clean import clean_nb_file
 from nbdocs.core import get_nb_names
-from nbdocs.settings import get_config
+from nbdocs.cfg_tools import get_config
 
 
 parser_cfg = ArgumentParserCfg(
@@ -23,7 +23,10 @@ class AppConfig:
         "nb_path", help="Path to NB or folder with Nbs to clean"
     )
     clear_execution_count: bool = field_argument(
-        flag="--no-ec", default=True, action="store_false", help="Clean execution counts."
+        flag="--no-ec",
+        default=True,
+        action="store_false",
+        help="Clean execution counts.",
     )
 
 

src/nbdocs/apps/app_nbdocs.py

@@ -1,15 +1,30 @@
+from pathlib import Path
 import sys
 from dataclasses import dataclass
 from typing import Optional, Sequence
 
-from argparsecfg import ArgumentParserCfg, field_argument, parse_args
+from argparsecfg import (
+    ArgumentParserCfg,
+    add_args_from_dc,
+    create_dc_obj,
+    create_parser,
+    field_argument,
+)
 from rich import print as rprint
 
 from nbdocs.convert import convert2md, filter_changed
 from nbdocs.core import get_nb_names
-from nbdocs.settings import get_config
+from nbdocs.cfg_tools import get_config
+from nbdocs.default_settings import (
+    NBDOCS_SETTINGS,
+    MKDOCS_BASE,
+    MATERIAL_BASE,
+    FOOTER_HTML,
+)
 
-parser_cfg = ArgumentParserCfg(description="NbDocs. Convert notebooks to docs. Default to .md")
+parser_cfg = ArgumentParserCfg(
+    description="NbDocs. Convert notebooks to docs. Default to .md"
+)
 
 
 @dataclass
@@ -21,7 +36,9 @@ class AppConfig:
     )
 
 
-def nbdocs(app_cfg: AppConfig,) -> None:
+def nbdocs(
+    app_cfg: AppConfig,
+) -> None:
     """NbDocs. Convert notebooks to docs. Default to .md"""
     cfg = get_config()
     nb_names = get_nb_names(cfg.notebooks_path)
@@ -45,9 +62,53 @@ def nbdocs(app_cfg: AppConfig,) -> None:
     convert2md(nb_names, cfg)
 
 
+@dataclass
+class SetupCfg:
+    clean: bool = field_argument(
+        "-c",
+        default=False,
+        action="store_true",
+        help="Clean MkDocs setup.",
+    )
+
+
+def setup(cfg: SetupCfg) -> None:
+    """Initialize config."""
+    rprint("Settings up NbDocs.")
+    # create nbdocs config - nbdocs.ini
+    with open("nbdocs.ini", "w", encoding="utf-8") as f:
+        f.write(NBDOCS_SETTINGS)
+    # create mkdocs config - mkdocs.yaml
+    mkdocs_setup = MKDOCS_BASE
+    if not cfg.clean:  # setting mkdocs material
+        mkdocs_setup += MATERIAL_BASE
+        # create footer with material
+        filename = Path("docs/overrides/partials/copyright.html")
+        filename.parent.mkdir(parents=True, exist_ok=True)
+        with open(filename, "w", encoding="utf-8") as f:
+            f.write(FOOTER_HTML)
+    with open("mkdocs.yaml", "w", encoding="utf-8") as f:
+        f.write(mkdocs_setup)
+    rprint("Done.")
+
+
 def main(args: Optional[Sequence[str]] = None) -> None:
-    app_cfg = parse_args(AppConfig, parser_cfg, args)
-    nbdocs(app_cfg)
+    parser = create_parser(parser_cfg)
+    add_args_from_dc(parser, AppConfig)
+    subparsers = parser.add_subparsers(title="Commands", help="Available commands.")
+    parser_init = subparsers.add_parser(
+        "init", help="Initialize config", description="Initialize NbDocs config"
+    )
+    parser_init.set_defaults(command="init")
+    add_args_from_dc(parser_init, SetupCfg)
+    parsed_args = parser.parse_args(args=args)
+    if hasattr(parsed_args, "command"):
+        if parsed_args.command == "init":
+            setup_cfg = create_dc_obj(SetupCfg, parsed_args)
+            setup(setup_cfg)
+    else:
+        app_cfg = create_dc_obj(AppConfig, parsed_args)
+        nbdocs(app_cfg)
 
 
 if __name__ == "__main__":

src/nbdocs/settings.py renamed to src/nbdocs/cfg_tools.py

@@ -16,7 +16,7 @@
     md_find_image_names,
     md_process_output_flag,
 )
-from nbdocs.settings import NbDocsCfg
+from nbdocs.cfg_tools import NbDocsCfg
 from nbdocs.typing import Nb, TPreprocessor
 
 

src/nbdocs/convert.py

@@ -0,0 +1,54 @@
+# settings schema for nbdocs and mkdocs.yaml
+
+NBDOCS_SETTINGS = """[nbdocs]
+docs_path = docs
+notebooks_path = nbs
+images_path = images
+"""
+
+
+MKDOCS_BASE = """site_name: Your site name
+# repo_url: Your repo url
+# repo_name: Your repo name
+# docs_dir: docs  # The docs directory.
+
+# copyright:
+"""
+
+MATERIAL_BASE = """theme:
+  name: material
+  custom_dir: docs/overrides
+
+  palette:
+    - scheme: default
+      toggle:
+        icon: material/toggle-switch-off-outline
+        name: Switch to dark mode
+    - scheme: slate
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to light mode
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+"""
+
+FOOTER_HTML = """<div class="md-copyright">
+  {% if config.copyright %}
+    <div class="md-copyright__highlight">
+      {{ config.copyright }}
+    </div>
+  {% endif %}
+  {% if not config.extra.generator == false %}
+    Made with
+    <a href="https://github.com/ayasyrev/nbdocs" target="_blank" rel="noopener">
+      NbDocs
+    </a>
+        and
+    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
+      Material for MkDocs
+    </a>
+  {% endif %}
+</div>
+"""

src/nbdocs/default_settings.py

@@ -8,7 +8,7 @@
 from nbconvert.exporters.exporter import ResourcesDict
 from nbconvert.preprocessors.base import Preprocessor
 
-from nbdocs.settings import NbDocsCfg
+from nbdocs.cfg_tools import NbDocsCfg
 from nbdocs.typing import CellAndResources, CodeCell, MarkdownCell, Nb, Cell
 
 

src/nbdocs/process.py

@@ -1 +1 @@
-__version__ = "0.2"
+__version__ = "0.2.1_dev"

src/nbdocs/version.py

@@ -3,7 +3,7 @@
 from pytest import CaptureFixture
 from nbdocs.core import get_nb_names, read_nb, write_nb
 from nbdocs.convert import MdConverter, convert2md, filter_changed
-from nbdocs.settings import NbDocsCfg
+from nbdocs.cfg_tools import NbDocsCfg
 
 from nbdocs.tests.base import create_nb, create_test_nb, create_tmp_image_file
 

tests/test_convert.py

@@ -3,7 +3,7 @@
 import pytest
 
 from nbdocs.core import get_nb_names, read_nb, write_nb
-from nbdocs.settings import get_config
+from nbdocs.cfg_tools import get_config
 from nbdocs.typing import Nb
 
 nb_path = Path("tests/test_nbs")

tests/test_core.py

@@ -9,7 +9,7 @@
     get_image_link_re,
     md_find_image_names,
 )
-from nbdocs.settings import NbDocsCfg
+from nbdocs.cfg_tools import NbDocsCfg
 from nbdocs.tests.base import create_tmp_image_file
 
 

tests/test_process_links.py

@@ -4,7 +4,7 @@
 
 import pytest
 
-from nbdocs.settings import (
+from nbdocs.cfg_tools import (
     NAMES,
     get_config,
     read_ini_config,