deploy: DiamondLightSource/python-copier-template@c78ba43

DiamondLightSource · Feb 9, 2024 · 34fae41 · 34fae41
1 parent 323f5fd
commit 34fae41
Show file tree

Hide file tree

Showing 42 changed files with 299 additions and 760 deletions.
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 1.0.2-53-g7b916d4
+_commit: 1.0.2-62-gc78ba43
 _src_path: gh:DiamondLightSource/python-copier-template
 author_email: [email protected]
 author_name: Tom Cobb

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,27 @@
+# Contribute to the project
+
+Contributions and issues are most welcome! All issues and pull requests are
+handled through [GitHub](https://github.com/DiamondLightSource/python-copier-template-example/issues). Also, please check for any existing issues before
+filing a new one. If you have a great idea but it involves big changes, please
+file a ticket before making a pull request! We want to make sure you don't spend
+your time coding something that might not fit the scope of the project.
+
+## Issue or Discussion?
+
+Github also offers [discussions](https://github.com/DiamondLightSource/python-copier-template-example/discussions) as a place to ask questions and share ideas. If
+your issue is open ended and it is not obvious when it can be "closed", please
+raise it as a discussion instead.
+
+## Code Coverage
+
+While 100% code coverage does not make a library bug-free, it significantly
+reduces the number of easily caught bugs! Please make sure coverage remains the
+same or is improved by a pull request!
+
+## Developer Information
+
+It is recommended that developers use a [vscode devcontainer](https://code.visualstudio.com/docs/devcontainers/containers). This repository contains configuration to set up a containerized development environment that suits its own needs.
+
+This project was created using the [Diamond Light Source Copier Template](https://github.com/DiamondLightSource/python-copier-template) for Python projects.
+The template's [Developer Guide](https://diamondlightsource.github.io/python-copier-template) contains detailed information on setting up a development environment, running the tests and what standards the code and documentation
+should follow.
diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst
diff --git a/.gitignore b/.gitignore
@@ -8,7 +8,6 @@ __pycache__/
 # Distribution / packaging
 .Python
 env/
-.venv
 build/
 develop-eggs/
 dist/

diff --git a/README.md b/README.md
@@ -0,0 +1,35 @@
+[![CI](https://github.com/DiamondLightSource/python-copier-template-example/actions/workflows/ci.yml/badge.svg)](https://github.com/DiamondLightSource/python-copier-template-example/actions/workflows/ci.yml)
+[![Coverage](https://codecov.io/gh/DiamondLightSource/python-copier-template-example/branch/master/graph/badge.svg)](https://codecov.io/gh/DiamondLightSource/python-copier-template-example)
+[![PyPI](https://img.shields.io/pypi/v/.svg)](https://pypi.org/project/)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+# python_copier_template_example
+
+This is where you should write a short paragraph that describes what your module does,
+how it does it, and why people should use it.
+
+Source          | <https://github.com/DiamondLightSource/python-copier-template-example>
+:---:           | :---:
+PyPI            | `pip install `
+Documentation   | <https://diamondlightsource.github.io/python-copier-template-example>
+Releases        | <https://github.com/DiamondLightSource/python-copier-template-example/releases>
+
+This is where you should put some images or code snippets that illustrate
+some relevant examples. If it is a library then you might put some
+introductory code here:
+
+```python
+from python_copier_template_example import __version__
+
+print(f"Hello python_copier_template_example {__version__}")
+```
+
+Or if it is a commandline tool then you might put some example commands here:
+
+```
+python -m python_copier_template_example --version
+```
+
+<!-- README only content. Anything below this line won't be included in index.md -->
+
+See https://diamondlightsource.github.io/python-copier-template-example for more detailed documentation.
diff --git a/README.rst b/README.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -44,8 +44,13 @@
     "sphinx_copybutton",
     # For the card element
     "sphinx_design",
+    # So we can write markdown files
+    "myst_parser",
 ]
 
+# So we can use the ::: syntax
+myst_enable_extensions = ["colon_fence"]
+
 # If true, Sphinx will warn about all references where the target cannot
 # be found.
 nitpicky = True
@@ -82,9 +87,6 @@
 # role, that is, for text marked up `like this`
 default_role = "any"
 
-# The suffix of source filenames.
-source_suffix = ".rst"
-
 # The master toctree document.
 master_doc = "index"
 

diff --git a/docs/developer/explanations/decisions.rst b/docs/developer/explanations/decisions.rst
diff --git a/docs/developer/explanations/decisions/0001-record-architecture-decisions.rst b/docs/developer/explanations/decisions/0001-record-architecture-decisions.rst
diff --git a/docs/developer/explanations/decisions/0002-switched-to-pip-skeleton.rst b/docs/developer/explanations/decisions/0002-switched-to-pip-skeleton.rst
diff --git a/docs/developer/how-to/build-docs.rst b/docs/developer/how-to/build-docs.rst
diff --git a/docs/developer/how-to/contribute.rst b/docs/developer/how-to/contribute.rst
diff --git a/docs/developer/how-to/lint.rst b/docs/developer/how-to/lint.rst
diff --git a/docs/developer/how-to/make-release.rst b/docs/developer/how-to/make-release.rst
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,7 +8,6 @@ __pycache__/ @@
     # Distribution / packaging
     .Python
     env/
-    .venv
     build/
     develop-eggs/
     dist/
@@ Expand Down @@