Hi all,

Version 0.2 of Documenter.jl <https://github.com/JuliaDocs/Documenter.jl> 
has been tagged. Documenter is a package for building documentation for 
Julia packages. The documentation is available from 
https://juliadocs.github.io/Documenter.jl/stable/.

This update includes several changes that will be relevant to users of the 
package:

   - 
   
   Doctests now only run jldoctest code blocks rather than julia and jlcon 
   blocks. See the manual section 
   <https://juliadocs.github.io/Documenter.jl/stable/man/doctests/> for 
   details. This follows the convention currently used in the standard library.
   - 
   
   Signature matching within @doc blocks is now more “picky” about what 
   method signatures match particular docstrings. This was changed to allow 
   for more fine-grained control of what to include within @doc blocks. If 
   you find a case where you feel it is being too picky, then please do file 
   an issue <https://github.com/JuliaDocs/Documenter.jl/issues>.
   - 
   
   Markdown footnotes 
   <http://docs.julialang.org/en/latest/manual/documentation/#footnotes> 
   (only available from Julia 0.5 onwards) are now checked to make sure each 
   footnote reference has a corresponding footnote body. As far as I can tell 
   there are no current uses within any publicly available packages, but 
   hopefully this feature will come in handy.
   - 
   
   @autodocs blocks 
   
<https://juliadocs.github.io/Documenter.jl/stable/man/syntax/#@autodocs-block-1>
 
   can now filter their contents base on whether a docstring in 
   exported/unexported.
   
As usual please report any issues you may encounter while using the package 
on the issue tracker <https://github.com/JuliaDocs/Documenter.jl/issues>.
------------------------------

Additionally, a new package has also been registered called 
DocStringExtenions.jl <https://github.com/JuliaDocs/DocStringExtensions.jl>. 
The documentation is available from 
https://juliadocs.github.io/DocStringExtensions.jl/stable/.

This package will be a home for new features that extend what Julia’s 
docsystem is able to do and that may, at some point, be included in the 
standard library if they prove useful enough. Currently it includes a 
collection of “abbreviation” objects which, when interpolated into 
docstrings, will auto-generate content such as method signatures, 
documentation for individual fields of composite types, module 
import/export lists. If you have any suggestions for new abbreviations 
you’d like to see please do open an issue 
<https://github.com/JuliaDocs/DocStringExtensions.jl/issues> to discuss 
them.

Finally, I’d like to give a big thank you to everyone that has been making 
use of Documenter, reporting issues, and contributing to the package.

— Mike
​

Reply via email to