Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Dec 1, 2023

Conversation

digital-carver
Copy link
Contributor

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
Copy link

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

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

@oxinabox oxinabox merged commit 4e0c352 into JuliaCollections:master Dec 1, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants