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.

Sign up for GitHub

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

Jump to bottom

Docs: Add toctree shortcode docs and render option in the Python script #406

Merged
merged 3 commits into from
Nov 13, 2023
Merged

Docs: Add toctree shortcode docs and render option in the Python script #406

merged 3 commits into from
Nov 13, 2023

Commits on Nov 13, 2023

  1. Add: (render_shortcode_docs.py) Options processing 

    This allows each shortcode file to pass a dict of options to this
Python program.

Currently the only one supported is "render", which may be set to
False to disable rendering of the shortcode into the documentation.
This is useful when a shortcode will not render meaningfully into the
documentation file (e.g. the "toctree" shortcode only works when in an
appropriate file hierarchy).
    @alphapapa
    alphapapa committed Nov 13, 2023
    Configuration menu
    Copy the full SHA
    c78eaba View commit details
    Browse the repository at this point in the history

  2. Docs: Add toctree shortcode documentation

    @alphapapa
    alphapapa committed Nov 13, 2023
    Configuration menu
    Copy the full SHA
    ed233c7 View commit details
    Browse the repository at this point in the history

  3. '[pre-commit.ci 🤖] Apply code format tools to PR'

    @pre-commit-ci
    pre-commit-ci[bot] committed Nov 13, 2023
    Configuration menu
    Copy the full SHA
    149601a View commit details
    Browse the repository at this point in the history