canonical / sphinx-docs-starter-pack

A documentation starter-pack
https://canonical-starter-pack.readthedocs-hosted.com/
Other
13 stars 35 forks source link

Quickstart improvements, plus alphabetical wordlist #187

Closed degville closed 6 months ago

degville commented 6 months ago

On adding http and https to the wordlist: I wanted the entire URL to be visible in the document (http://127.0.0.1), and I couldn't get the replace:: syntax to work adequately. As reStructuredText seems to support standalone hyperlinks (they're rendered properly in the HTML preview, and on GitHub), I thought adding http and https to the worldlist was reasonable.

ru-fu commented 6 months ago

On adding http and https to the wordlist: I wanted the entire URL to be visible in the document (http://127.0.0.1), and I couldn't get the replace:: syntax to work adequately. As reStructuredText seems to support standalone hyperlinks (they're rendered properly in the HTML preview, and on GitHub), I thought adding http and https to the worldlist was reasonable.

This should do it:

Link |http://127.0.0.1:8000|_

.. |http://127.0.0.1:8000| replace:: ``http://127.0.0.1:8000``
.. _`http://127.0.0.1:8000`: http://127.0.0.1:8000

I wouldn't block the PR for it, but I'm really not a fan of putting http in the default word list. I use the spelling check to enforce correct terminology, and the correct spelling for the protocol is "HTTP" and not "http". The spelling check will usually catch that, but not if we add it as an exception to the word list.

degville commented 6 months ago

Link |http://127.0.0.1:8000|_

Thanks @ru-fu! Brilliant. This worked, so I removed http and https from the wordlist.

ru-fu commented 6 months ago

Thanks @ru-fu! Brilliant. This worked, so I removed http and https from the wordlist.

Great, thanks! And just to point out, we need to go for this complicated solution here because the file needs to display alright both on GitHub and in the built output. Usually, we wouldn't care much for the GitHub rendering and could use our custom literalref role.