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

doc: Small additions linking templates/themes to demo site. #3634

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

htgoebel
Copy link

@htgoebel htgoebel commented Jul 8, 2022

Pull Request Checklist

  • I’ve read the guidelines for contributing.

    since the change is trivial, I abstreined from creating an issue first.

  • I updated AUTHORS.txt and CHANGES.txt (if the change is non-trivial) and documentation (if applicable).

    not applicable

  • I tested my changes.

Description

Adds a few lines of text pointing from the templates/themes section to the demo site section. I was missing such a link.

@Kwpolska
Copy link
Member

Kwpolska commented Aug 1, 2022

The tests fail, probably due to invalid link targets. Can you look into this?

auto-merge was automatically disabled August 2, 2022 09:03

Head branch was pushed to by a user without write access

@htgoebel
Copy link
Author

htgoebel commented Aug 2, 2022

I pushed a new version fixing this issue (rebased on current master bracnh already).

Lessons learned:

  • `demo site <demo-site>`_ does not link to the internal target "demo-site" (href='#demo-site"), but to the file (href="demo-site")
  • internal targets can contain spaces: Both .. _`demo site`: and .. _demo site: (without backticks) are okay

@blaisep
Copy link

blaisep commented Aug 11, 2022

I pushed a new version fixing this issue (rebased on current master bracnh already).

Lessons learned:

  • `demo site <demo-site>`_ does not link to the internal target "demo-site" (href='#demo-site"), but to the file (href="demo-site")
  • internal targets can contain spaces: Both .. _`demo site`: and .. _demo site: (without backticks) are okay

IIRC, in rst, if you want to point to the link in the final output you will want to use the :doc: field.

@htgoebel
Copy link
Author

:doc: role is an extension, AFAIK sphinx introduced it. And was the name says, it is for linking to (the top of) documents.

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.

None yet

3 participants