JuliaCollections / IterTools.jl

Common functional iterator patterns
Other
152 stars 28 forks source link

docs: add an index and move the docstrings to a reference page #113

Closed digital-carver closed 9 months ago

digital-carver commented 10 months ago

One disadvantage of using Autodocs now is that the nice, easy-to-navigate list of names in the left sidebar that's in the stable docs, is no longer there in the dev docs.

This PR uses Documenter's @index feature to generate an index of names as a replacement. I also moved the (@autodoc-ed) docstrings to a separate reference page, since it looks nicer to have just a quick list of functions at a glance in the homepage, instead of showing the intimidating full listing of docstrings right away.

codecov-commenter commented 10 months ago

Codecov Report

Merging #113 (cc473a5) into master (403cdca) will decrease coverage by 0.03%. The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #113      +/-   ##
==========================================
- Coverage   90.77%   90.75%   -0.03%     
==========================================
  Files           1        1              
  Lines         401      400       -1     
==========================================
- Hits          364      363       -1     
  Misses         37       37              

see 1 file with indirect coverage changes

:mega: Codecov offers a browser extension for seamless coverage viewing on GitHub. Try it in Chrome or Firefox today!