stan-dev / docs

Documentation for the Stan language and CmdStan
https://mc-stan.org/docs/
Other
38 stars 108 forks source link

Add an index of all functions to the HTML site #739

Closed WardBrian closed 5 months ago

WardBrian commented 6 months ago

Submission Checklist

Summary

We have an index in the PDF, but not in the website. This closes #367 and has more recently been requested by @SteveBronder.

Here's how the current output looks:

image

How it works:

This PR adds two pieces of automation, both based around the existing HTML comments we have in the functions reference.

The first is a Pandoc filter which, when it sees one of those comments, generates a HTML anchor based on the SHA-1 hash of that comment.

The second is a script based off of our existing extract_function_sigs.py which generates a .qmd file containing the current list of functions - found based on the same comments as the filter.

Copyright and Licensing

Please list the copyright holder for the work you are submitting (this will be you or your assignee, such as a university or company):

By submitting this pull request, the copyright holder is agreeing to license the submitted work under the following licenses: