Semantics

[ramanshah]

Should be comprehensive but minimal.

Brainstorm:

nerdydoc init [-c conf.yml] [-p my_package]       # Inspect working dir; produce a config file
nerdydoc build [-c conf.yml]                      # Read the config file; build the docs
nerdydoc init build [-c conf.yml] [-p my_mackage] # nerdydoc init, then nerdydoc build

A thought is to omit a nerdydoc clean and just have users rm -r docs/. I think this removes a layer of indirection.

[ramanshah]

The hope is to make the idiomatic entry point bone simple. Say one has a repo my_package with directory structure as follows:

my_package
| - my_package
    | - __init__.py
    | - various_smart_code.py
| - README.md
| - LICENSE

Then I should be able to type

$ nerdydoc init build

and a directory docs/ will appear with a reasonable documentation website with API documentation, the README.md as a front page, and the LICENSE as a section.

[ramanshah]

One subtlety: it would be great for the default stuff in the config file to be generic for sharing on GitHub. One could have nerdydoc detect the pwd for this kind of breezy default usage but also accept an absolute --prefix or something for more complex usage.