incremental progress on #19 - populating the contributor's guide #73
Conversation
README.md
Outdated
| However, many of the links will not work. For all of the links found in the portal to work properly, you'll need to set up a local testing server. This can be done with Python's http.server by running the following command from within the `content` directory: | ||
|
|
||
| ``` | ||
| python -m http.server --directory _build/html/ | ||
| ``` | ||
|
|
||
| and then pointing your browser at the URL: `localhost:8000` |
There was a problem hiding this comment.
It's my understanding that this step isn't needed since we provide a live directive in the Makefile for running the server:
projectpythia.github.io/content/Makefile
Lines 15 to 17 in 6f0a893
I think this could be replaced by
make liveThere was a problem hiding this comment.
sphinx-autobuild has an added benefit of including a livereload enabled web server
There was a problem hiding this comment.
@andersy005 that would be cool. Have you tried it? When I run 'make live' I get into what looks like an infinite loop. I've tried blowing away the _build directory first.
There was a problem hiding this comment.
When I run 'make live' I get into what looks like an infinite loop.
The make live command doesn't return because sphinx-autobuild keeps watching the directory for new changes (when you make changes to the source files, it rebuilds the website without you having to re-run the make live command) ...
There was a problem hiding this comment.
Hmm. Doesn't seem to be working for me: the links still aren't being resolved. Have you tried it? What is the order of operations you are using?
There was a problem hiding this comment.
It's currently not working on my end. I suggest merging this PR as is, then I will look into this issue in a separate PR.
There was a problem hiding this comment.
Sounds good to me if you want to resolve this comment and approve the PR. Thanks
Co-authored-by: Kevin Paul <[email protected]>
A few minor clarifications. No substantiative changes