A comprehensive collection of data science technical concepts. The purpose of
this work is to consolidate notes taken over the years on various data science
topics and make it easily accessible via a web browser by using Read the Docs for hosting.
The documentation can be found here.
Note: This project is still under construction. More documentation and references will be added as the project matures.
To get started, first create a virtual environment and within this environment, install the required dependencies by running:
pip install requirements.txt
Next, to build the docs locally for testing purposes, you can run the following command from within the project root directory:
sphinx-autobuild -b html source source/build/html -E
An alternative shortcut command to build the docs is to run:
make docs
This will launch a web server on port 8000 and builds the doc locally. To access the docs, navigate to http://127.0.0.1:8000 in your browser.
When contributing to the project, it's recommended to edit the markdown files
in source/book within an editor like VS Code. A handy shortcut command
cmd-shift-v in VS Code allows you to view the rendered markdown file in a
side-by-side view along with the source markdown file being edited.
Once changes are made and ready to be published, please open a pull request on
the development branch for a review. After the changed are approved, a merge
request will automatically updated the published page for the
project.
Prior to committing the changes and opening a pull-request, you can run the following pre-commit library to check for any potential errors:
Checks
check-merge-conflict: Check for files that contain merge conflicts.pre-commit-sphinx: A pre-commit hook that will fail if documentation.
To run the pre-commit checks, you'll need to first stage the files by running
git add and then run:
make pre-commit
Alternatively before staging the changes, you can run the following command to check for any errors:
pre-commit run --all-files