Skip to content

Commit

Permalink
1. add instructions to build with orcid publications. 2. fixed versio…
Browse files Browse the repository at this point in the history
…n of docutils.
  • Loading branch information
pbellec committed Jun 18, 2024
1 parent c39f8d9 commit d713fda
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,10 @@ If you'd like to develop and/or build the SIMEXP website, you should:
1. Clone this repository
2. Run `pip install -r content/requirements.txt` (it is recommended you do this within a virtual environment)
3. (Optional) Edit the books source files located in the `content/` directory
4. Run `jupyter-book clean content/` to remove any existing builds
5. Run `jupyter-book build content/`
4. In a terminal, move to the `content` directory
5. Run `python orcid_to_bib.py` to update the content of the publication section.
4. Run `jupyter-book clean .` to remove any existing builds
5. Run `jupyter-book build .` to create the book

A fully-rendered HTML version of the book will be built in `content/_build/html/`.

Expand Down
1 change: 1 addition & 0 deletions content/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ numpy
sphinx_design
requests
tqdm
docutils==0.17.1

0 comments on commit d713fda

Please sign in to comment.