E. Scott Daniels | e7cb2aa | 2021-02-09 09:51:15 -0500 | [diff] [blame^] | 1 | This directory contains files which may seem (and probably are) |
| 2 | out of place in the root. Mostly these are CI files which should |
| 3 | really be placed into a CI directory, but must exist here else |
| 4 | the CI mechanics fall over. This is a list of these odd files. |
| 5 | |
| 6 | |
| 7 | docs -- This directory contains generated documentation that is |
| 8 | scraped and placed on an external documentation site. The directory |
| 9 | name must be exactly "doc" and the CI/doc jobs fail if there |
| 10 | are files in the directory which are not referenced by the |
| 11 | index. |
| 12 | |
| 13 | rmr-version.yaml The CI vetting processes create environments |
| 14 | which include the RMR libraries. This file contains a single |
| 15 | definition of the desired RMR version to use in these |
| 16 | environments. There should be no need for RMR in any of |
| 17 | the evironments used to vet this code, so the version here |
| 18 | just needs to reference something available. |
| 19 | |
| 20 | tox.ini -- It is unclear exactly what this is for given that |
| 21 | there is no python code associated with this repo. The only |
| 22 | guess is that the document scraper/verification CI job is |
| 23 | a python application and requires this. |
| 24 | |
| 25 | .readthedocs.yaml -- Another doc CI configuration bit of goop. |
| 26 | |
| 27 | releases -- This is a directory which contains a single yaml file |
| 28 | used to indicate to the CI jobs which library should be moved |
| 29 | from the package cloud staging repo to the release repo. See |
| 30 | the README in that directory for more details. |
| 31 | |
| 32 | |
| 33 | The rest of the files, like .git* should be well known to developers |
| 34 | and thus are not explained here. |