https://github.com/cannlytics/cannlytics-docs
🔥 Cannlytics 📚 Documentation
https://github.com/cannlytics/cannlytics-docs
cannabis cannabis-api cannabis-app cannabis-data cannabisapp django metrc python statistics
Last synced: 6 days ago
JSON representation
🔥 Cannlytics 📚 Documentation
- Host: GitHub
- URL: https://github.com/cannlytics/cannlytics-docs
- Owner: cannlytics
- License: mit
- Created: 2021-09-20T21:12:59.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-20T06:35:39.000Z (almost 2 years ago)
- Last Synced: 2025-09-24T00:32:18.597Z (9 months ago)
- Topics: cannabis, cannabis-api, cannabis-app, cannabis-data, cannabisapp, django, metrc, python, statistics
- Language: Dockerfile
- Homepage: https://docs.cannlytics.com
- Size: 7.89 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
You can read the Cannlytics documentation at [https://docs.cannlytics.com](https://docs.cannlytics.com).
## Writing documentation
Documentation for Cannlytics is written in [Markdown](https://guides.github.com/features/mastering-markdown/) and lives in the `docs` folder. The configuration for the documentation is contained within `mkdocs.yml`. Building the documentation requires [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) and [Docker](https://www.docker.com/get-started).
## Building the documentation
First, you will need to pull and build the Material for MKDocs Docker image:
```shell
docker pull squidfunk/mkdocs-material
docker build -t squidfunk/mkdocs-material docs
```
or
```shell
npm run install
```
You will also need to install the Python dependencies for the documentation:
```shell
pip install -r docs/requirements.txt
```
Once you have a copy of the Docker image, you can preview the documentation as you write:
```shell
docker run --rm -it -p 8000:8000 -v "%cd%":/docs squidfunk/mkdocs-material
```
or
```shell
npm run start
```
You can preview the documentation at while you develop.
!!! note
There is [a namespace conflict between `django-livereload-server` and `livereload`](https://gist.github.com/hangtwenty/f53b3867db1e33780505ccafd8d2eef0), so you need to be careful when and where you install Python requirements. If you run into a `django-livereload-server` import error, first check that `PRODUCTION=False` in your `.env` file and then follow [these instructions](https://gist.github.com/hangtwenty/f53b3867db1e33780505ccafd8d2eef0) to uninstall `livereload` and reinstall `django-livereload-server`.
## Publishing documentation
When you are ready, you can build the documentation with:
```shell
npm run build
```
Finally, you can publish the documentation with:
```shell
npm run publish
```
Congratulations, you can now read the documentation at [https://docs.cannlytics.com](https://docs.cannlytics.com).