Skip to content

Commit

Permalink
Merge pull request #2256 from moj-analytical-services/ignore_to_docs_…
Browse files Browse the repository at this point in the history
…docs

add note about excludedocs
  • Loading branch information
RobinL authored Jul 16, 2024
2 parents ea9e151 + 78c5183 commit 84d1995
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions docs/dev_guides/changing_splink/contributing_to_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,22 @@ This is much faster than waiting for GitHub actions to run if you're trying to m

Once you've finished updating Splink documentation we ask that you run our spellchecker. Instructions on how to do this are given below.

## Quick builds for rapidly authoring new content

When you `mkdocs serve -v --dirtyreload` or `mkdocs build` the documentation, the `mkdocs` command will rebuild the entire site. This can be slow if you're just making small changes to a single page.

To speed up the process, you can temporarily tell `mkdocs` to ignore content by modifying `mkdocs.yml`, for example by adding:

```yml
exclude_docs: |
dev_guides/**
charts/**
topic_guides/**
demos/**
blog/**
```
## Spellchecking docs
When updating Splink documentation, we ask that you run our spellchecker before submitting a pull request. This is to help ensure quality and consistency across the documentation. If for whatever reason you can't run the spellchecker on your system, please don't let this prevent you from contributing to the documentation. Please note, the spellchecker _only works on markdown files_.
Expand All @@ -30,7 +46,7 @@ To run the spellchecker on either a single markdown file or folder of markdown f
./scripts/pyspelling/spellchecker.sh <path_to_file_or_folder>
```

Omitting the file/folder path will run the spellchecker on all markdown files contained in the `docs` folder. We recommend running the spellchecker only on files that you have created or edited.
Omitting the file/folder path will run the spellchecker on all markdown files contained in the `docs` folder. We recommend running the spellchecker only on files that you have created or edited.

The spellchecker uses the Python package [PySpelling](https://facelessuser.github.io/pyspelling/) and its underlying spellchecking tool, Aspell. Running the above script will automatically install these packages along with any other necessary dependencies.

Expand All @@ -56,9 +72,9 @@ Please correct any mistakes found or update the custom dictionary to ensure the











0 comments on commit 84d1995

Please sign in to comment.