updated docs strings and added README.md
This commit is contained in:
@@ -1,9 +1,11 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Command line interface entry point for doc-forge.
|
||||
|
||||
This module exposes the primary CLI entry function used by the
|
||||
``doc-forge`` command. The actual command implementation resides in
|
||||
``docforge.cli.main``, while this module provides a stable import path
|
||||
`doc-forge` command. The actual command implementation resides in
|
||||
`docforge.cli.main`, while this module provides a stable import path
|
||||
for external tools and the package entry point configuration.
|
||||
|
||||
The CLI is responsible for orchestrating documentation workflows such as
|
||||
@@ -13,17 +15,22 @@ servers.
|
||||
|
||||
---
|
||||
|
||||
Typical usage
|
||||
-------------
|
||||
# Typical usage
|
||||
|
||||
The CLI is normally invoked through the installed command:
|
||||
|
||||
doc-forge <command> [options]
|
||||
```bash
|
||||
doc-forge <command> [options]
|
||||
```
|
||||
|
||||
Programmatic invocation is also possible:
|
||||
|
||||
Example:
|
||||
|
||||
```python
|
||||
from docforge.cli import main
|
||||
main()
|
||||
```
|
||||
|
||||
---
|
||||
"""
|
||||
|
||||
Reference in New Issue
Block a user