Add ma docs command

Author: idlesign

CHANGELOG.md

@@ -1,6 +1,9 @@
 # makeapp changelog
 
 
+### Unreleased
+* ++ Add 'ma docs' command.
+
 ### v2.0.0 [2025-10-04]
 * !! Big rewrite. Now uses up-to-date conventions and technologies.
 * ++ Add 'ma' alias for 'makeapp' command.

README.md

@@ -19,6 +19,7 @@ https://github.com/idlesign/makeapp
 * Easily add entries to your changelog.
 * Publish your application to remotes (VCS, PyPI) with a single command.
 * Easily bootstrap your development environment.
+* Build and local serve the docs.
 * Run code styling/linting.
 
 ## Application scaffolding
@@ -94,6 +95,15 @@ Apply code style with `style` command:
 ma style
 ```
 
+
+## Build/serve docs
+
+Use `docs` command:
+
+``` bash
+ma docs
+```
+
 ## Documentation
 
 https://makeapp.readthedocs.io/

docs/040_development.md

@@ -38,3 +38,11 @@ To style/lint your code use the following command:
 ```bash
 ma style
 ```
+
+## Build/serve docs
+
+Use `docs` command:
+
+``` bash
+ma docs
+```

docs/index.md

@@ -14,6 +14,7 @@
 * Easily add entries to your changelog.
 * Publish your application to remotes (VCS, PyPI) with single command.
 * Easily bootstrap your development environment.
+* Build and local serve the docs.
 * Run code styling/linting.
 
 

src/makeapp/apptools.py

@@ -8,7 +8,7 @@
 from .helpers.files import FileHelper
 from .helpers.vcs import VcsHelper
 from .helpers.venvs import VenvHelper
-from .utils import chdir, configure_logging, Uv, Ruff
+from .utils import chdir, configure_logging, Uv, Ruff, MkDocs
 
 LOG = logging.getLogger(__name__)
 
@@ -510,6 +510,10 @@ def style(self):
         LOG.info('Styling ...')
         Ruff.check()
 
+    def docs(self, *, serve: bool = True):
+        LOG.info('Making docs ...')
+        MkDocs.serve() if serve else MkDocs.build()
+
     def venv_init(self, *, reset: bool = False, register_tool: bool = False):
         self.venv.initialize(reset=reset)
 

src/makeapp/cli.py

@@ -234,6 +234,19 @@ def style(debug):
     click.secho('Done', fg='green')
 
 
+@entry_point.command()
+@option_debug
+@click.option(
+    '-b', '--build',
+    help='Build only. Do not serve', is_flag=True
+)
+def docs(debug, build):
+    """Build/serve documentation."""
+    project = Project(log_level=logging.DEBUG if debug else logging.INFO)
+    project.docs(serve=not build)
+    click.secho('Done', fg='green')
+
+
 def main():
     try:
         entry_point(obj={})

src/makeapp/utils.py

@@ -163,6 +163,22 @@ def check(cls, fix: bool = True) -> list[str]:
         return cls._run(f'check{" --fix" if fix else ""}')
 
 
+class MkDocs:
+    """MkDocs wrapper."""
+
+    @classmethod
+    def _run(cls, cmd: str) -> list[str]:
+        return run_command(f'mkdocs {cmd}', capture=False)
+
+    @classmethod
+    def serve(cls) -> list[str]:
+        return cls._run('serve -o')
+
+    @classmethod
+    def build(cls) -> list[str]:
+        return cls._run('build')
+
+
 class Uv:
     """Uv wrapper."""