Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

Commit

Permalink
Update details on how to use new cookiecutter
Browse files Browse the repository at this point in the history
  • Loading branch information
banesullivan committed Oct 14, 2018
1 parent a36d712 commit 24164aa
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.rst
Expand Up @@ -46,10 +46,42 @@ Install `gendocs` from PyPI:
$ pip install gendocs
Cookiecutter
^^^^^^^^^^^^

Want to easily create a new project that will build its own documentation?
Try the ``gendocs`` Cookiecutter which will prompt you for your new projects
details and create all the needed project structure for your new, automatically
documented Python package.

To create a new project, make sure you have Cookiecutter_ installed in your
virtual environment:

.. _Cookiecutter: https://github.com/audreyr/cookiecutter


.. code-block:: bash
$ pip install cookiecutter
Now you can use Cookiecutter_ to create a new project ready for ``gendocs`` by
executing the following command and following the prompts:


.. code-block:: bash
$ cookiecutter https://github.com/banesullivan/cookiecutter-gendocs.git
That's it! Now you have a new Python project ready for automatic documentation
and deployment.

Usage
^^^^^

Already have a Python package in need of automatic documentation? Follow these steps.

This generator is built for Sphinx (RST) documentation.
To document your package, setup sphinx and a ``conf.py`` then add the following
somewhere near the top of your ``conf.py``:
Expand Down

0 comments on commit 24164aa

Please sign in to comment.