-
Notifications
You must be signed in to change notification settings - Fork 45
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
New readme section : Requirements to build html page in virtual environments #443
Draft
antoinemeyer5
wants to merge
3
commits into
kokkos:main
Choose a base branch
from
antoinemeyer5:simple-build-safe-env-guide
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
# Python Virtual Environment | ||
/venv | ||
/env | ||
# PyCharm files | ||
/.idea | ||
# Rendered html files | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,7 +7,7 @@ This is needed just for local render of documentation, so it can be checked befo | |
Requirements are in `build_requirements.txt` | ||
Could be installed with: `pip install -r build_requirements.txt` | ||
|
||
## Build | ||
### Build | ||
|
||
``` | ||
cd docs | ||
|
@@ -20,7 +20,7 @@ cd docs | |
make clean | ||
``` | ||
|
||
## Displaying the site locally | ||
### 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: | ||
|
||
|
@@ -32,3 +32,42 @@ 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/). | ||
|
||
## Requirements to build html page in virtual environments | ||
|
||
```bash | ||
# 1. install virtualenv (if needed) | ||
python3 -m pip install --user virtualenv | ||
|
||
# 2. clone this repository | ||
git clone [email protected]:kokkos/kokkos-core-wiki.git | ||
cd kokkos-core-wiki | ||
|
||
# 3. create virtual environment | ||
python3 -m venv env | ||
|
||
# 4. activate virtual environment | ||
source env/bin/activate | ||
|
||
# 5. install doc requirements | ||
python3 -m pip install -r build_requirements.txt | ||
|
||
# 6. build | ||
cd docs | ||
make html | ||
|
||
# 7. display | ||
cd docs/generated_docs | ||
python3 -m http.server | ||
``` | ||
|
||
Usefull commands: | ||
```bash | ||
# list installed packages | ||
python3 -m pip list | ||
|
||
# leave virtual environment | ||
deactivate | ||
``` | ||
|
||
Source: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/ |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
CAVEAT: there might be limits on using this (PyCharm) IDE in certain environments.