Skip to content

Commit

Permalink
Exclude API controllers from documentation
Browse files Browse the repository at this point in the history
# Conflicts:
#	.yardopts
  • Loading branch information
sdjmchattie committed Aug 20, 2024
1 parent c246283 commit 485de71
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,18 +67,16 @@ a organisation of 900 people.
In addition to the [externally hosted YARD docs](https://www.rubydoc.info/github/sanger/sequencescape), you can also run a local server:

```shell
yard server -r --gems -m sequencescape .
yard server --reload sequencescape
```

You can then access the Sequencescape documentation through: [http://localhost:8808/docs/sequencescape](http://localhost:8808/docs/sequencescape)

Yard will also try and document the installed gems: [http://localhost:8808/docs](http://localhost:8808/docs)
You can then access the Sequencescape documentation through: [http://localhost:8808/docs](http://localhost:8808/docs)

If the server complains that the stack depth is too deep, this only appears to be a problem when you try to view the documentation without pre-compiling it.
Precompiling is the simple solution and can be achieved with the following.

```shell
yard doc -r -m sequencescape .
yard doc sequencescape
```

This will pre-fill the cache and allow the server command above to display the documentation without complaining about stack depths.
Expand Down

0 comments on commit 485de71

Please sign in to comment.