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 documentation for HeadingPlugin and TOCPlugin #246

Merged
merged 8 commits into from
Nov 25, 2024

Conversation

sourcery-ai[bot]
Copy link
Contributor

@sourcery-ai sourcery-ai bot commented Nov 25, 2024

Resolves #229

Add comprehensive documentation for the HeadingPlugin and TOCPlugin, including configuration details, usage examples, and best practices for content organization.

Documentation:

  • Add new documentation for the HeadingPlugin, detailing configuration options, anchor settings, and usage examples.
  • Introduce documentation for the TOCPlugin, explaining its dependency on heading anchors and the required rendering order.
  • Update the index to include the new documentation pages for HeadingPlugin and TOCPlugin.

This PR was automatically generated.

If you want to make changes to this PR:

  • Leave a review and I'll make the changes
  • Leave a comment with the changes you want to see
  • Push commits to the branch

Add comprehensive documentation for the HeadingPlugin and TOCPlugin, including configuration details, usage examples, and best practices for content organization.

Documentation:
- Add new documentation for the HeadingPlugin, detailing configuration options, anchor settings, and usage examples.
- Introduce documentation for the TOCPlugin, explaining its dependency on heading anchors and the required rendering order.
- Update the index to include the new documentation pages for HeadingPlugin and TOCPlugin.

Resolves #229
@sourcery-ai sourcery-ai bot requested a review from fsbraun November 25, 2024 15:31
docs/source/index.rst Outdated Show resolved Hide resolved
docs/source/plugins/toc.rst Outdated Show resolved Hide resolved
docs/source/plugins/toc.rst Outdated Show resolved Hide resolved
docs/source/plugins/toc.rst Outdated Show resolved Hide resolved
@fsbraun fsbraun merged commit 90b744e into master Nov 25, 2024
30 of 31 checks passed
@fsbraun fsbraun deleted the sourcery-ai/issue-229 branch November 25, 2024 15:48
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.

docs: Add documentation for heading and table of contents
1 participant