https://github.com/anovos/anovos-docs
Documentation repo for Anovos
https://github.com/anovos/anovos-docs
comprehensive docs documentation feature-engineering mkdocs scale
Last synced: about 2 months ago
JSON representation
Documentation repo for Anovos
- Host: GitHub
- URL: https://github.com/anovos/anovos-docs
- Owner: anovos
- Created: 2021-10-21T03:15:38.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-01T04:57:36.000Z (over 3 years ago)
- Last Synced: 2024-04-16T20:09:46.799Z (about 2 years ago)
- Topics: comprehensive, docs, documentation, feature-engineering, mkdocs, scale
- Language: Mako
- Homepage: https://docs.anovos.ai
- Size: 29.3 MB
- Stars: 6
- Watchers: 6
- Forks: 3
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Anovos Docs
This is the repository for [_Anovos_](https://github.com/anovos/anovos)' documentation.
The docs are built using [`mkdocs`](https://github.com/mkdocs/mkdocs) using the
[`mkdocs-material`](https://squidfunk.github.io/mkdocs-material/) theme
and deployed to [docs.anovos.ai](https://docs.anovos.ai).
## Contributing to the Anovos Docs
### Setting up
To get started, first clone the repository:
```shell
git clone https://github.com/anovos/anovos-docs.git
```
Then, enter the newly created `anovos-docs` folder and install `mkdocs` and the other dependencies by running:
```shell
pip install -r requirements.txt
```
To build and serve the docs locally, run:
```shell
mkdocs serve
```
If you're a regular contributor, we recommend to install the development requirements and use the pre-commit hooks:
```shell
pip install -r dev_requirements.txt
pre-commit install
```
### Editing the docs
Simply edit the Markdown files or add new ones.
If you added a new file and would like it to show up in the navigation bar,
don't forget to add it to the `nav` section in [`mkdocs.yml`](./mkdocs.yml).
Once you're done, commit your changes, push them to a new branch and open a Pull Request so that they can be reviewed.
### Adding Images
All images for the site are stored in the `docs/assets`.
Upload your images in this folder, then put those images in the correct pages using Markdown:
```markdown
```
### Merging and Deploying
Once your changes have been committed and pushed to the repo, create a detailed Pull Request (PR) for review.
A maintainer from the repo will review the changes and merge your PR.
The Anovos Docs repo has a GitHub Action that automatically deploys the updates to the website.
## Updating the API documentation
The [API documentation](https://docs.anovos.ai/api/) is automatically generated.
There is a [GitHub Action workflow](https://github.com/anovos/anovos-docs/actions/workflows/apidocs.yml)
that can be triggered to run manually.
It fetches the current version of the library, generates the API docs and opens a PR that can be reviewed
and merged just as any other contribution to the docs.