docs_example

Example for learning about docs

Installation

Here is how to install

Create environment

Create conda environment with:

conda env create -f environment.yml

Docs

Docs are available as follows:

1. As notebook sitting into repo: https://github.com/axiom-data-science/docs_example/blob/main/example_notebooks/example.ipynb
2. Compiled locally and pushed to GH Pages: https://axiom-data-science.github.io/docs_example
3. Compiled by Read the Docs automatically: https://docs-example-axds.readthedocs.io/