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

Overhaul rendering of the manual #2565

Merged
merged 8 commits into from
Apr 13, 2024

Conversation

Kodiologist
Copy link
Member

Here are various changes, in combination with a commit I just pushed to hyhomepage, to clean up the manual and put it on hylang.org. You can see the result at http://hylang.org/hy/doc/doc-testing. URLs that now look like

https://docs.hylang.org/en/stable/syntax.html

will instead be

https://hylang.org/hy/doc/v0.26.0/syntax

  • I use version numbers insted of stable and master because cool URIs don't change. We'll no longer provide official web versions of pre-release versions of the Hy manual, and that should no longer be terribly necessary now that Hy isn't breaking backwards compatibility so frequently. I'll redirect docs.hylang.org to the latest release.
  • The file extension (.html) is gone because it's an implementation detail.
  • en is gone because full translations, if they're ever written (which I doubt), will probably be hosted under different URLs, as with Python itself.

If there are no objections, I'll make similar arrangements for Hyrule's manual, too.

in preparation for contents sidebars being removed.
It's not very useful for this repository, anyway, because it doesn't work with Hy files.
It's a needless complication. The reStructuredText source is better seen on GitHub.
@Kodiologist Kodiologist merged commit f74b5a7 into hylang:master Apr 13, 2024
10 checks passed
@goyalyashpal
Copy link

goyalyashpal commented Apr 13, 2024

but stable and master do help others to link to the latest versions of a documentation.

the expected is for the stable to automatically redirect to the link with latest version number

  • en is gone because full translations, if they're ever written (which I doubt), will probably be hosted under different URLs, as with Python itself.

oh lol, on point :)

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.

Stop using Read the Docs
2 participants