search

jerbaroo / bridge-sim

Python library for concrete slab bridge simulation.
MIT License
1 stars 0 forks source link

Test that docs are up-to-date #177

Open jerbaroo opened 4 years ago

jerbaroo commented 4 years ago

Build the docs as part of the test script and compare the newly built docs to the previously built docs.

Then CircleCI won't let us push code to the repo without up-to-date docs.

jerbaroo commented 3 years ago

I don't like this actually. Continually testing documentation, and requiring commits to include documentation will mean commits are obscured by HTML files.

Instead this test should only be done as part of the release script #190

jerbaroo commented 3 years ago

This is added as part of #190 however there's a problem with pdoc. pdoc can't handle NewType s. Everytime that docs are generated, any NewType which is part of a type annotation is replaced with an address in memory e.g. 0x12345678.