4. Root Directory Files

There are a lot of files in the root directory. The purpose of this file is to document what each of the files are used for.

4.1. Files

4.1.1. .codecov.yml

The configuration file for codecov.io, a tool to automatically detect and process test coverage.

Currently the file is set up such that after the tests are run, there will be no status check. In the future, this file will be change so that if the commit results in a significant decrease in code coverage, there will be a status check at a failing state.

4.1.2. .gitignore

Tells git which files and directories should not be tracked.

4.1.3. .travis.yml

The configuration file for travis-ci.org, a continuous integration tool.

Currently the file runs the test suite and notifies codecov.io of changes on success. Ideally Python 3.9 would also be automatically tested, but I’m not sure how to set that up.

4.1.4. conf.py

The configuration file for the Sphinx documentation builder.

4.1.5. example.py

An example of racketinterpreter.

4.1.6. index.rst

The Sphinx documentation master file. Also the documentation homepage.

4.1.7. LICENSE.rst

An MIT license.

4.1.8. make.bat

An autogenerated file that makes simplifies the processes for generating documentation.

4.1.9. Makefile

An autogenerated file that makes simplifies the processes for generating documentation.

4.1.10. README.rst

An introduction to the project.

4.1.11. requirements.txt

The packages (and their versions) that this project depends on.

In the future it will be split into sections for documentation, publishing, and the project itself.

4.1.12. setup.py

Used in the process of generating distribution archives. Specifies metadata about the project.