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

Remove include_cextern_folder option #447

Merged
merged 2 commits into from
Feb 11, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions QUESTIONS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,11 @@ a description of each of the prompts.
7. ``project_url``: Project website.
8. ``include_example_code``: This includes a set of example python files showing you how to use the package template. If you choose ``n`` then none of this will be included and you will have to populate the directory structure before you can import the package.
9. ``use_compiled_extensions``: Whether you plan to use compiled extensions in your package
10. ``include_cextern_folder``: The cextern folder should be used if you are including non-python C code.
11. ``edit_on_github_extension``: Set to ``True`` to enable the edit on GitHub sphinx extension.
12. ``github_project``: This is the GitHub identifier for the edit on GitHub extension and the changelog link extension.
13. ``use_travis_ci``: If ``'y'`` the template will include an example ``.travis.yml`` file for the Travis CI service.
14. ``use_read_the_docs``: If ``'y'`` the ``read_the_docs.yml`` and ``.rtd-environment.yml`` files will be included for using conda on Read the Docs.
15. ``sphinx_theme``: The value of the ``html_theme`` variable in the sphinx configuration file.
16. ``required_dependencies``: Comma-separated list of required dependencies
17. ``optional_dependencies``: Comma-separated list of optional dependencies
18. ``minimum_python_version``: Version string of minimum supported Python version
10. ``edit_on_github_extension``: Set to ``True`` to enable the edit on GitHub sphinx extension.
11. ``github_project``: This is the GitHub identifier for the edit on GitHub extension and the changelog link extension.
12. ``use_travis_ci``: If ``'y'`` the template will include an example ``.travis.yml`` file for the Travis CI service.
13. ``use_read_the_docs``: If ``'y'`` the ``read_the_docs.yml`` and ``.rtd-environment.yml`` files will be included for using conda on Read the Docs.
14. ``sphinx_theme``: The value of the ``html_theme`` variable in the sphinx configuration file.
15. ``required_dependencies``: Comma-separated list of required dependencies
16. ``optional_dependencies``: Comma-separated list of optional dependencies
17. ``minimum_python_version``: Version string of minimum supported Python version
1 change: 0 additions & 1 deletion cookiecutter.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
"author_email": "",
"license": ["BSD 3-Clause", "GNU GPL v3+", "Apache Software Licence 2.0", "BSD 2-Clause", "Other"],
"project_url": "http://docs.astropy.org/projects/package-template/",
"include_cextern_folder": "n",
"use_compiled_extensions": "y",
"include_example_code": "y",
"edit_on_github_extension": "False",
Expand Down
1 change: 0 additions & 1 deletion docs/options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ a description of each of the prompts:
#. ``project_url``: Project website.
#. ``include_example_code``: This includes a set of example python files showing you how to use the package template. If you choose ``n`` then none of this will be included and you will have to populate the directory structure before you can import the package.
#. ``use_compiled_extensions``: Whether you plan to use compiled extensions in your package
#. ``include_cextern_folder``: The cextern folder should be used if you are including non-python C code.
#. ``edit_on_github_extension``: Set to ``True`` to enable the edit on GitHub sphinx extension.
#. ``github_project``: This is the GitHub identifier for the edit on GitHub extension and the changelog link extension.
#. ``use_travis_ci``: If ``'y'`` the template will include an example ``.travis.yml`` file for the Travis CI service.
Expand Down
3 changes: 0 additions & 3 deletions hooks/post_gen_project.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,3 @@ def process_licence(licence_name):

if '{{ cookiecutter.use_compiled_extensions }}' != 'y' or '{{ cookiecutter.include_example_code }}' != 'y':
remove_file('{{ cookiecutter.module_name }}/example_c.pyx')

if '{{ cookiecutter.include_cextern_folder }}' != 'y':
remove_dir('cextern')
1 change: 0 additions & 1 deletion rendered.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ default_context:
project_version: "0.0.dev"
include_example_code: "y"
use_compiled_extensions: "y"
include_cextern_folder: "y"
edit_on_github_extension: "False"
github_project: "astropy/astropy"
use_travis_ci: "y"
Expand Down
1 change: 0 additions & 1 deletion {{ cookiecutter.package_name }}/MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ include pyproject.toml
recursive-include {{ cookiecutter.module_name }} *.pyx *.c *.pxd
recursive-include docs *
recursive-include licenses *
recursive-include cextern *
recursive-include scripts *

prune build
Expand Down
7 changes: 0 additions & 7 deletions {{ cookiecutter.package_name }}/cextern/README.rst

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
"""
This packages contains python packages that are bundled with the package but
are external to it, and hence are developed in a separate source tree. Note
that this package is distinct from the /cextern directory of the source code
distribution, as that directory only contains C extension code.
are external to it, and hence are developed in a separate source tree.
"""