Add note about doctests in docstrings #1265
Merged
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
Suggest to add modules with doctests in docstrings to the `modules` argument. Otherwise you get the strange situation where the doctests are not run when running `makedocs` but do run and potentially fail when running `doctest`.
fredrikekre
approved these changes
Mar 20, 2020
|
Just to clarify: this is for when you are building docs for multiple packages at once? It should not be necessary to list all submodules of your package separately if you already have the top-level module there. |
|
In this specific case I was completely missing the |
mortenpi
reviewed
Mar 22, 2020
Co-Authored-By: Morten Piibeleht <morten.piibeleht@gmail.com>
briochemc
added a commit
to briochemc/Documenter.jl
that referenced
this pull request
Apr 10, 2020
* JuliaDocs-master: (138 commits) Add example admonition css to example build (JuliaDocs#1284) Pass non-standard admonition categories on in HTML output (JuliaDocs#1280) Suggest using the `aligned` environment (JuliaDocs#1275) Update DiffEq docs link (JuliaDocs#1274) Make Deps.pip a closure again (JuliaDocs#1240) Recommend Julia 1.4 in the manual (JuliaDocs#1272) Add note about doctests in docstrings (JuliaDocs#1265) Fix minted/lstlistings escaping (JuliaDocs#1269) Changelog for 0.24.7 (JuliaDocs#1266) Test with Julia 1.4 instead of 1.3 on CI (JuliaDocs#1268) Fix doctest testing on nightly (JuliaDocs#1267) remove "only" from search stop word filter (JuliaDocs#1264) Reorganize some Sass variables to make theming easier (JuliaDocs#1258) Fix outdated links in the manual (JuliaDocs#1255) Fix LaTeX tests for tags (JuliaDocs#1256) Install TagBot as a GitHub Action (JuliaDocs#1237) use Julia 1.3 for .travis hosting example (JuliaDocs#1235) Set version to 0.24.5 (JuliaDocs#1233) Support REPL softscope for Julia 1.5. (JuliaDocs#1232) Discourage use of matrix: in Travis conf (JuliaDocs#1231) ...
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.
Suggest to add modules with doctests in docstrings to the
modulesargument. Otherwise you get the strange situation where the doctests are not run when runningmakedocsbut do run and potentially fail when runningdoctest.CC: @fredrikekre