https://github.com/kokkos/kokkos-core-wiki
https://github.com/kokkos/kokkos-core-wiki
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kokkos/kokkos-core-wiki
- Owner: kokkos
- Created: 2022-02-28T20:08:45.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-04T23:41:07.000Z (4 months ago)
- Last Synced: 2025-02-05T00:25:47.199Z (4 months ago)
- Size: 68 MB
- Stars: 4
- Watchers: 27
- Forks: 50
- Open Issues: 69
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# kokkos-core-documentation-website
Welcome to the Kokkos Documentation repository. This is the source for https://kokkos.github.io/kokkos-core-wiki/.
## Requirements to build html page locally
This is needed just for local render of documentation, so it can be checked before push.
Requirements are in `build_requirements.txt`
Could be installed with: `pip install -r build_requirements.txt`
## Build
```
cd docs
make html
```
To clean:
```
cd docs
make clean
```
## Displaying the site locally
`docs/generated_docs/index.html` can be opened in a web browser, or alternatively you can use python's built-in http server:
```bash
cd docs/generated_docs
python3 -m http.server
```
Then, navigate to http://localhost:8000
Alternatively, if you would like to auto refresh every time you run make, the documentation works with [httpwatcher](https://pypi.org/project/httpwatcher/).