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

Rename all @id in docs #144

Merged
merged 3 commits into from
May 29, 2024
Merged

Rename all @id in docs #144

merged 3 commits into from
May 29, 2024

Conversation

ytdHuang
Copy link
Member

@ytdHuang ytdHuang commented May 29, 2024

Summary of this PR:

  • Delete removed file (install.md)
  • add docs/README.md for tutorial of building documentation locally.
  • add QuantumToolbox to [deps] in docs/Project.toml (see the tutorial in docs/README.md)
  • Rename all @id (as discussed below)

If we define some title as:

# [Some Title](@id doc: Some Title)

We have to reference it with the quotation marks "" due to the blank spaces in @id, namely

... click [here](@ref "doc: Some Title") ...

So I suggest to change the @id naming rule as

# [Some Title](@id doc:Some-Title)

Basically is just remove all blank spaces (and add hyphen - if needed).
In this way, we can just reference it by

... click [here](@ref doc:Some-Title) ...

@ytdHuang ytdHuang changed the title Rename all \@id\ in docs Rename all @id in docs May 29, 2024
@ytdHuang ytdHuang merged commit 9786ddf into qutip:main May 29, 2024
2 checks passed
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.

2 participants