Allow running just doctests #32376
Merged
Allow running just doctests #32376
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Jun 26, 2019
* Bump Documenter to 0.23.1 * Documenter now requires docstring doctests to have their own metadata in the corresponding module. Remove all the now redundant at-meta blocks from the standard library .md files and add the necessary module-level metadata in make.jl
mortenpi
changed the title
|
This should be good to go -- the doctesting feature is in a Documenter release now and the unnecessary at-meta blocks are gone. So, locally you can now run |
Keno
pushed a commit
that referenced
this pull request
Jun 5, 2024
* Bump Documenter to 0.23.1 * Documenter now requires docstring doctests to have their own metadata in the corresponding module. Remove all the now redundant at-meta blocks from the standard library .md files and add the necessary module-level metadata in make.jl
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds
doctest=onlyoption todocs/make.jlso that you could run only doctests. This could maybe then be run as part of the normal test suite.All doctests are now being tested, even the ones that are not in the manual. This actually revealed a bunch of docstrings that are not in the manual (some probably should) which contain broken doctests (should be fixed anyhow). For the moment they are "disabled", to get the rest of the manual to pass.
On the other hand, the docstrings are no longer tied to a manual page for doctesting purposes. This means that the
@metablocks in the manual.mdfiles no longer have an effect on the docstrings. So instead there is agensymed variable in each module that can contain that metadata. Most of these at-meta blocks were justusing STDLIBfor the given standard library, so theDocTestSetups are now added automatically in themake.jlfile.Very WIP at the moment, I am curious to see what happens with this on CI. It passes locally. It depends on JuliaDocs/Documenter.jl#774.
disabled-doctest, probably in a separate PR (Add a few methods to manual & fix doctests #32417)index.mdfiles.doctest = :onlyoption in a Documenter release and updatedocs/manifest.