Skip to content

Commit

Permalink
fix some typos and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sosey committed Dec 2, 2024
1 parent 26c12d7 commit f31f773
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
16 changes: 13 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,23 @@ If you would like to stick to simply the cookiecutter approach, the template sti
$ pip install cookiecutter
$ cookiecutter gh:Roman-Supernova-PIT/package-template -o ./output_directory
This will create a new directory in your current directory named the same as the value of "packagename" you supplied.
Change into this directory and run ``git init`` to make it into a git repository, and make an initial commit.
This is required in order to have software versioning working for your package.
This will create a new directory in your current directory named the same as the value of "packagename" you supplied. Change into this directory and run ``git init`` to make it into a git repository, and make an initial commit. Then pip install into a clean environment and try building docs:

.. code-block:: console
$ pip install -e ".[docs,test]"
$ cd docs
$ make html
This is required in order to have software versioning working for your package, and to test creating docs.

The goal of the template is to quickly get you setup with the files described in the guide.
The template currently implements the following optional flags, all of which default to off:

* ``include_example_code``: This option will fill your new package with some example functions to allow you to test it.
* ``use_compiled_extensions``: This turns on the features needed to support compiled extensions
* ``enable_dynamic_dev_versions``: This enables a feature which ensures that ``my_package.__version__`` always returns the current git version as calculated by ``setuptools_scm`` when the package is installed as an editable install.



4 changes: 2 additions & 2 deletions {{ cookiecutter.package_name }}/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,8 @@ name = "Documentation"
showcontent = true

[[tool.towndcrier.type]]
directory = {{ cookiecutter.module_name }}
name = " {{ cookiecutter.module_name }}"
directory = "{{ cookiecutter.module_name }}"
name = "{{ cookiecutter.module_name }}"
showcontent = true


0 comments on commit f31f773

Please sign in to comment.