Skip to content

Fix the version in the title for the latest version #10

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.

Sign up for GitHub

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

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

Fix the version in the title for the latest version #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion toc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
html_title = "UForge Docs latest documentation"

@jgweir jgweir Jul 19, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The title is a little strange, maybe just: UForge Documentation

@Wazabiii Wazabiii Jul 20, 2017

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you go to http://docs.usharesoft.com/en/latest/
The title is: Welcome to the UForge Online Documentation - UForge Docs 1.0 documentation

We can't use the word "latest" in these variables ("version" or "release") in the conf.py because of the format of the variable.
We use the "html_title" var to rewrite the title.

html_title = "UForge Docs latest documentation"
Will change the title to: Welcome to the UForge Online Documentation - UForge Docs latest documentation

In 3.6 (with 'version' var) it will be: Welcome to the UForge Online Documentation - UForge Docs 3.6 documentation

If we use:

html_title = "UForge Documentation"
The title will look like: Welcome to the UForge Online Documentation - UForge Documentation
Wich is not pretty.


# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
Expand Down