-
Notifications
You must be signed in to change notification settings - Fork 21
Add Read the Docs autobuild to contributors guide #26
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
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
974104c
adding autobuild instructions to contributors.md
jukent 1a1708f
Merge branch 'main' into popcontrib
jukent 57868c4
Update CONTRIBUTING.md
jukent 8d939b9
Merge branch 'main' into popcontrib
5e5ff08
Update CONTRIBUTING.md
jukent e8a5190
Update CONTRIBUTING.md
jukent cdb515d
add ams talk to about.md
jukent 9e0ea7e
Revert "add ams talk to about.md"
jukent c2b96aa
Merge branch 'main' into popcontrib
jukent 1de5206
Merge branch 'main' into popcontrib
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 hidden or 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 |
---|---|---|
|
@@ -18,28 +18,43 @@ For questions or anything else you would like to share with the [Project Pythia | |
|
||
The portal site is built with [Sphinx](https://www.sphinx-doc.org/). | ||
|
||
To build and view the site locally (e.g. for testing new content), | ||
use [conda](https://docs.conda.io/) to set up a build environment with all dependencies: | ||
When testing new content is important to build and view the site. Read the Docs automatically builds the site for you when each Pull Request is checked. You can also build it locally on your machine. | ||
|
||
### To view the Read the Docs autobuild | ||
|
||
Once a Pull Request has passed all tests, including the Read the Docs build, you can click "Details" of the check that says, "docs/readthedocs.org:projectpythia - Read the Docs build succeeded!" to launch a new tab with a build of the Project Pythia site. (You may have to click "Show all checks" for this to be displayed.) | ||
|
||
 | ||
|
||
### To build and view the site locally | ||
|
||
- Fork the [source repository](https://github.com/ProjectPythia/projectpythia.github.io) on GitHub | ||
- Make a local clone of the repository on your machine | ||
``` bash | ||
git clone [email protected]:USERNAME/projectpythia.github.io.git | ||
# or | ||
git clone https://github.com/USERNAME/projectpythia.github.io.git | ||
``` | ||
- In your favorite terminal, navigate to the `content` directory of the source repository | ||
```bash | ||
cd projectpythia.github.io/content | ||
``` | ||
- Use [conda](https://docs.conda.io/) to set up a build environment: | ||
``` | ||
conda env create -f ../ci/environment.yml | ||
conda activate pythia | ||
``` | ||
``` bash | ||
conda env create -f ../ci/environment.yml | ||
conda activate pythia | ||
``` | ||
- Build the site locally using Sphinx (which you just installed in the `pythia` environment, along with all necessary dependencies): | ||
``` | ||
make html | ||
``` | ||
``` bash | ||
make html | ||
``` | ||
- The newly rendered site is now available in `content/_build/html/index.html`. | ||
Open with your web browser, or from the terminal: | ||
``` | ||
open _build/html/index.html | ||
``` | ||
``` bash | ||
open _build/html/index.html | ||
``` | ||
- When you're done, you can deactivate the dedicated build environment with | ||
``` | ||
conda deactivate | ||
``` | ||
``` bash | ||
conda deactivate | ||
``` | ||
- You can re-activate the `pythia` conda environment at any time with `conda activate pythia`. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.
Uh oh!
There was an error while loading. Please reload this page.