Skip to content

Commit

Permalink
Merge pull request #64 from university-of-york/feature/newpages
Browse files Browse the repository at this point in the history
tweak readme
  • Loading branch information
nd996 authored Oct 10, 2023
2 parents 2b812a8 + e07e424 commit b35df3c
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,22 @@ Clone the repo, install `sphinx` through

`pip install sphinx sphinx-rtd-theme`

### Compile the web pages
**Compile the web pages**

`sphinx-build -b html docs/source site/`

### View the website
**View the website**

Open `site/index.html` in a web browser.

There isn't a development server that auto-builds bundled with Sphinx.
When your changes are ready to be deployed, submit a PR and request approval.

### Check links are valid
**Check links are valid**

`sphinx-build -b linkcheck docs/source site/`

## Replacement
There isn't a development server that auto-builds bundled with Sphinx.
When your changes are ready to be deployed, submit a PR and request approval.

**Replacement**

The `docs/source/replacements.py` file contains a dictionary of replacement words to use throughout the docs. For exmaple, all the module versions to load in the jobscript examples. This makes it simple to update that part of the docs in the future.

Expand Down

0 comments on commit b35df3c

Please sign in to comment.