https://github.com/ray-project/q4-2021-docs-hackathon
https://github.com/ray-project/q4-2021-docs-hackathon
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ray-project/q4-2021-docs-hackathon
- Owner: ray-project
- License: apache-2.0
- Created: 2021-12-16T23:08:23.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-12-23T08:58:24.000Z (about 4 years ago)
- Last Synced: 2025-01-15T21:42:17.153Z (12 months ago)
- Language: HTML
- Size: 10.7 MB
- Stars: 2
- Watchers: 9
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 2021 Q4 Ray documentations hackathon: Proposal for new Ray documentation
# Instructions
To install all dependencies with Python 3, run
```shell
pip install -r requirements.txt
```
To build and run the documentation then simply run
```shell
mkdocs build
```
# About
- This proof-of-concept is built using [MkDocs Material](https://squidfunk.github.io/mkdocs-material/)
- Changes merged into the `main` branch will be automatically build and published at: https://ray-project.github.io/q4-2021-docs-hackathon
- Using [mike](https://github.com/jimporter/mike) to manage versioning
- Note that the Github CI is using a fake version (i.e. v0.3). It will always deploy changes to the 0.3 version just for demo purposes.
- Code snippets are include using [`mdx_include`](https://github.com/neurobin/mdx_include)
- Jupyter notebooks get rendered on the fly with [`mkdocs-jupyter`](https://github.com/danielfrg/mkdocs-jupyter)
- API references are generated with [`mkdocstrings`](https://github.com/mkdocstrings/mkdocstrings)