added requested changes to readme and changelog

Author: lukeruud

CHANGELOG.md

@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 You should also add project tags for each release in Github, see [Managing releases in a repository](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository).
 
 ## [Unreleased]
-
+- Added example auto-built Sphinx documentation in the `docs` folder
 ## [1.0.0] - 2022-05-23
 ### Added
 - README and CHANGELOG

README.md

@@ -63,27 +63,37 @@ So what does each file in this repository do?
 ```
 .
 ├── cdstemplate     # The python package root - Any code you'd like to be able to import lives here
-│   ├── corpus_counter_script.py    # A script that takes a list of documents as input and outputs a CSV of word counts
-│   ├── __init__.py     # Indicates that this directory is a python package, you can put special import instructions here
-│   ├── word_count.py    # A module that has functions and classes to import
-│   └── utils.py    # A module that handles logging and other internals
+    ├── corpus_counter_script.py    # A script that takes a list of documents as input and outputs a CSV of word counts
+    ├── __init__.py     # Indicates that this directory is a python package, you can put special import instructions here
+    ├── word_count.py    # A module that has functions and classes to import
+    └── utils.py    # A module that handles logging and other internals
 ├── CHANGELOG.md    # Versioning information
 ├── dag_workflow.png    # An image that is linked to in this README
 ├── data    # Data files which may or may not be tracked in Git, but we reserve a folder for them so that users can all have the same relative paths
-│   ├── gutenberg     # Sample text input files, the raw inputs to our experiment pipeline.
-│   └── gutenberg_counts.csv     # The expected output file for our experiment. It's generated by `dvc repro` and is ignored by git.
+    ├── gutenberg     # Sample text input files, the raw inputs to our experiment pipeline.
+    └── gutenberg_counts.csv     # The expected output file for our experiment. It's generated by `dvc repro` and is ignored by git.
+├── docs     # Sphinx auto-documentation uses this folder to run its scripts and store documentation
+    ├── _build     # Contains the Sphinx doctree and html documentation source code
+        ├── doctrees     # A folder with doctree construction information
+        └── html   # A folder that contains the html code for all automatically created documentation
+    ├── _static     # A folder that can contain static code
+    ├── _templates    # A folder that can contain Sphinx templates
+    ├── conf.py    # A function that configures Sphinx according to user specifications  
+    ├── index.rst    # A directory that users can input new functions into for auto-documentation
+    ├── make.bat    # A function that runs auto-documentation
+    └── Makefile    # A function that creates html documentation based on functions in the index.rst file
 ├── dvc.lock    # Data Version Control uses this file to compare experiment versions. It's tracked in Git, but don't edit it manually.
 ├── dvc.yaml    # Create the Data Version Control pipeline stages here
 ├── notebooks
-│   └── word_count_prototype.ipynb    # A jupyter notebook that makes pretty plots
+    └── word_count_prototype.ipynb    # A jupyter notebook that makes pretty plots
 ├── pyproject.toml    # The setuptools build tools are installed, so you project can be installed
 ├── README.md     # You're reading it now!
 ├── setup.cfg   # Project metadata and dependencies are declared for proper installation
 └── tests
     └── test_word_count.py    # Unit and smoke tests for the word_count module
 ├── .dvc    # The configuration file for Data Version Control
 ├── .github
-|   └── workflows/python_package.yml    # Github Workflow file, configures running tests on Github every time a pull request to the main branch is made
+    └── workflows/python_package.yml    # Github Workflow file, configures running tests on Github every time a pull request to the main branch is made
 ├── .gitignore   # Lists files that should not be included in version control, created from Github's template .gitignore for Python.
 └── .dvcignore    # Lists files that Data Version Control should skip when checking for changes in stage dependencies.
 ```
@@ -97,6 +107,7 @@ The README, CHANGELOG and docstrings are just as important.
 - _README.md_ : Summarize the project's purpose and give installation instructions.
 - _CHANGELOG.md_ : Tell the user what has changed between versions and why, see [Keep A CHANGELOG](https://keepachangelog.com/en/1.0.0/)
 - docstrings: Appear directly in your code and give an overview of each function or object. They can be printed using `help(object)` from the python interpreter or used to automatically generate API documentation with a tool like [Sphinx](https://www.sphinx-doc.org/en/master/index.html). There are many different docstring formats. Your team can choose any they like, just be consistent. This template uses [reStructuredText style](https://peps.python.org/pep-0287/).
+- Sphinx  : Create html documentation for your functions based on the docstrings you write in the code. Use [Sphinx](https://www.sphinx-doc.org/en/master/index.html) to streamline the documentation process.
 
 Read [Real Python's Documenting Python Code: A Complete Guide](https://realpython.com/documenting-python-code/) for more ideas about effectively documenting code. The `.md` files are written using [Markdown](https://www.markdownguide.org/), a handy formatting language that is automatically rendered in Github.