Skip to content
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
21 changes: 21 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?= -T -E -d _build/doctrees -D language=en
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = ../_readthedocs/

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

4 changes: 3 additions & 1 deletion docs/source/new_project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,9 @@ At this point, your new project is hydrated and ready for you to start coding. B
Commit your new project locally
-------------------------------------------------------------------------------

If you're interested in using pre-commit hooks to crosscheck your code before you commit it, now is a good time to set that up (it's just one command) - check out `"Helpful pre-commit hooks" <https://github.com/lincc-frameworks/python-project-template#helpful-pre-commit-hooks>`_.
If you're interested in using pre-commit hooks to crosscheck your code before you commit it,
now is a good time to set that up (it's just one command) - check out
:doc:`</practices/precommit>`.

Commit the project to your local version control like so to see the pre-commit checks run.

Expand Down
5 changes: 4 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,7 @@ requires = [
"setuptools>=45", # Used to build and package the Python project
"setuptools_scm>=6.2", # Gets release version from git. Makes it available programmatically
]
build-backend = "setuptools.build_meta"
build-backend = "setuptools.build_meta"

[tool.setuptools_scm]
write_to = "_version.py"