-
Notifications
You must be signed in to change notification settings - Fork 17
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
Improve README, add MarkDown changelog, and mention documentation in the PyPI links #249
Conversation
Co-authored-by: Maxwell G <maxwell@gtmx.me>
"Source code" = "https://github.com/ansible-community/antsibull-docs" | ||
"Code of Conduct" = "https://docs.ansible.com/ansible/latest/community/code_of_conduct.html" | ||
"Bug tracker" = "https://github.com/ansible-community/antsibull-docs/issues" | ||
"Changelog" = "https://github.com/ansible-community/antsibull-docs/tree/main/CHANGELOG.md" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, but I'd consider including the Changelog in the documentation site and linking to that instead. You can symlink docs/changelog.md -> ../CHANGELOG.md
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried that, but it looks like shit, since mkdocs only supports a specific dialect of MarkDown and not CommonMark. IIRC it shows \
everywhere since the MarkDown dialect it supports doesn't allow to use it for escaping.
(Ref: mkdocs/mkdocs#1835)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I opened ansible-community/antsibull-changelog#153. There is still the double table of contents (one from mkdocs-material and another from antsibull-changelog), but at least, it's properly formatted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/changelog/table of contents/
@gotmax23 thanks for reviewing this! |
Thanks for working on it! |
No description provided.