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

Allow to specify toctree elements that are not strings #45

Merged
merged 1 commit into from
Oct 3, 2022
Merged

Allow to specify toctree elements that are not strings #45

merged 1 commit into from
Oct 3, 2022

Conversation

felixfontein
Copy link
Collaborator

For example, this allows to have

---
sections:
  - title: Changelog
    toctree:
      - title: Changelog
        ref: CHANGELOG

in docs/docsite/extra-docs.yml to get a toctree entry Changelog <docsite/CHANGELOG>.

Implements #31 (comment)

CC @briantist

@felixfontein felixfontein mentioned this pull request Sep 27, 2022
Closed
briantist
briantist approved these changes Sep 27, 2022
View reviewed changes
Copy link
Contributor

@briantist briantist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent!

@felixfontein
Copy link
Collaborator Author

See https://ansible.fontein.de/collections/community/hashi_vault/#changelog for the result with the above example.

@briantist
Copy link
Contributor

An in comparison, the current view: https://docs.ansible.com/ansible/devel/collections/community/hashi_vault/index.html#changelog

@felixfontein felixfontein merged commit 141b9b0 into ansible-community:main Oct 3, 2022
@felixfontein felixfontein deleted the toctree branch October 3, 2022 19:12
@felixfontein
Copy link
Collaborator Author

@briantist thanks for reviewing this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@briantist briantist briantist approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@felixfontein @briantist