Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding conda info for libraries, polishing #462

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
# kokkos-core-documentation-website
# kokkos-core-documentation project
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`
The library-level dependencies needed for Kokkos documentation are:

- Sphinx
- furo
- myst-parser
- sphinx-copybutton
- m2r2
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think all this above is superfluous, and we are just duplicating what is writte in the build_requirements.txt.

Copy link
Member

@dalg24 dalg24 Oct 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, please refer to the requirement file and do not duplicate content. This would inevitably go out of date.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. I'll. close this PR


Each of the above libraries can be installed using `conda` or `pip`.

These libraries are needed for local documentation rendering, a critical check *before* creating pull requests (PR), and updating existing PR.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please remove this sentence, I don't think it adds much. We are already saying what the requirements are, the word says it all :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK


These requirements are in `build_requirements.txt,` and can be installed with: `pip install -r build_requirements.txt`

## Build

Expand All @@ -24,11 +34,14 @@ make clean

`docs/generated_docs/index.html` can be opened in a web browser, or alternatively you can use python's built-in http server:

```bash
```
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/).
- For `conda` or `pip`, please install `pytest-httpserver`

Alternatively, if you would like to auto refresh every time you run make, the documentation works with [httpwatcher](https://pypi.org/project/httpwatcher/). This library is only available for `pip` installation.