You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: devtools/README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
# Development, testing, and deployment tools
2
2
3
-
This directory contains a collection of tools for running Continuous Integration (CI) tests,
3
+
This directory contains a collection of tools for running Continuous Integration (CI) tests,
4
4
conda installation, and other development tools not directly related to the coding process.
5
5
6
6
7
7
## Manifest
8
8
9
9
### Continuous Integration
10
10
11
-
You should test your code, but do not feel compelled to use these specific programs. You also may not need Unix and
11
+
You should test your code, but do not feel compelled to use these specific programs. You also may not need Unix and
12
12
Windows testing if you only plan to deploy on specific platforms. These are just to help you get started.
13
13
14
14
### Conda Environment:
@@ -17,7 +17,7 @@ This directory contains the files to setup the Conda environment for testing pur
17
17
18
18
*`conda-envs`: directory containing the YAML file(s) which fully describe Conda Environments, their dependencies, and those dependency provenance's
19
19
*`test_env.yaml`: Simple test environment file with base dependencies. Channels are not specified here and therefore respect global Conda configuration
20
-
20
+
21
21
### Additional Scripts:
22
22
23
23
This directory contains OS agnostic helper scripts which don't fall in any of the previous categories
@@ -40,17 +40,17 @@ This directory contains OS agnostic helper scripts which don't fall in any of th
40
40
-[ ] Make sure there is an/are issue(s) opened for your specific update
41
41
-[ ] Create the PR, referencing the issue
42
42
-[ ] Debug the PR as needed until tests pass
43
-
-[ ] Tag the final, debugged version
43
+
-[ ] Tag the final, debugged version
44
44
*`git tag -a X.Y.Z [latest pushed commit] && git push --follow-tags`
45
45
-[ ] Get the PR merged in
46
46
47
47
## Versioneer Auto-version
48
-
[Versioneer](https://github.com/warner/python-versioneer) will automatically infer what version
49
-
is installed by looking at the `git` tags and how many commits ahead this version is. The format follows
48
+
[Versioneer](https://github.com/warner/python-versioneer) will automatically infer what version
49
+
is installed by looking at the `git` tags and how many commits ahead this version is. The format follows
50
50
[PEP 440](https://www.python.org/dev/peps/pep-0440/) and has the regular expression of:
51
51
```regexp
52
52
\d+.\d+.\d+(?\+\d+-[a-z0-9]+)
53
53
```
54
-
If the version of this commit is the same as a `git` tag, the installed version is the same as the tag,
55
-
e.g. `ffsettings-0.1.2`, otherwise it will be appended with `+X` where `X` is the number of commits
54
+
If the version of this commit is the same as a `git` tag, the installed version is the same as the tag,
55
+
e.g. `ffsettings-0.1.2`, otherwise it will be appended with `+X` where `X` is the number of commits
56
56
ahead from the last tag, and then `-YYYYYY` where the `Y`'s are replaced with the `git` commit hash.
Copy file name to clipboardExpand all lines: docs/README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,15 +4,15 @@ The docs for this project are built with [Sphinx](http://www.sphinx-doc.org/en/m
4
4
To compile the docs, first ensure that Sphinx and the ReadTheDocs theme are installed.
5
5
6
6
```bash
7
-
conda install sphinx sphinx_rtd_theme
7
+
conda install sphinx sphinx_rtd_theme
8
8
```
9
9
10
10
Once installed, you can use the `Makefile` in this directory to compile static HTML pages by
11
11
```bash
12
12
make html
13
13
```
14
14
15
-
The compiled docs will be in the `_build` directory and can be viewed by opening `index.html` (which may itself
15
+
The compiled docs will be in the `_build` directory and can be viewed by opening `index.html` (which may itself
16
16
be inside a directory called `html/` depending on what version of Sphinx is installed).
17
17
18
18
A configuration file for [Read The Docs](https://readthedocs.org/) (readthedocs.yaml) is included in the top level of the repository. To use Read the Docs to host your documentation, go to https://readthedocs.org/ and connect this repository. You may need to change your default branch to `main` under Advanced Settings for the project.
0 commit comments