MyST-Parser
MyST-Parser copied to clipboard
DOC: index <title> tag just says "Overview"
Describe the bug
context
<title> tags for the docs could have a suffix that includes e.g. "| MyST-Parser Documentation" for searchability
expectation I expected to: have more than "Overview" to visually identify and textually search for the myst-parser docs tab.
bug But instead: it just says "Overview"
$ jupyter-book build mybook
ERROR ...
problem This is a problem for people doing ___ because ___.
Reproduce the bug
- Visit: https://myst-parser.readthedocs.io/en/latest/ and view Title tag
List your environment
No response
Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:
Is there a conf.py setting for title tags in sphinx but not jupyterbook?
Thanks for the pointer @westurner, how does #721 look? https://myst-parser--722.org.readthedocs.build/en/722/index.html
On modern (especially mobile) browsers we only have a few characters to differentiate between tabs
- "Overview"
- "MyST Parser Overview"
- "MyST Parser Intro"
- "MyST Parser Core Syntax"
So the prefix of the tab is most relevant in distinguishing between tabs;
- "Overview | MyST-Parser Documentation"
- "Intro | MyST-Parser Documentation"
- "Core Syntax | MyST-Parser Documentation"
- "Core Syntax | MyST-Parser Documentation"
- "Core Syntax < Guides | MyST-Parser Documentation"
Are there breadcrumbs from sphinx or jupyter-book.
Sphinx includes the word "Documentation" in the title tags IIRC. That probably also matches "docs"? So that "myst parser docs" finds the correct page
On Sat, Feb 25, 2023, 11:16 AM Chris Sewell @.***> wrote:
Thanks for the pointer @westurner https://github.com/westurner, how does #721 https://github.com/executablebooks/MyST-Parser/issues/721 look? https://myst-parser--722.org.readthedocs.build/en/722/index.html
— Reply to this email directly, view it on GitHub https://github.com/executablebooks/MyST-Parser/issues/721#issuecomment-1445151215, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAMNS5GNZKLNJZ7ALODUC3WZIV6FANCNFSM6AAAAAAVHCDI7M . You are receiving this because you were mentioned.Message ID: @.***>
Sorry I'm a little confused by what you are after here 😅
Should I prepend "| MyST Parser", to all titles, rather than append?
Or maybe you can you give some specific examples, of what you would like to see appear in the html?
Are there breadcrumbs from sphinx or jupyter-book.
I'd note myst-parser has no dependence on jupyter-book (it's the other way around) Not sure exactly what you mean by breadcrumbs here? As in the nesting of the page under subsections?