Bug 636 – Unable to navigate back to the main site from the generated documentation

PySide Bugzilla Closed for New Bugs

PySide is now a Qt Add-on and uses the Qt Project's JIRA Bug Tracker instead of this Bugzilla instance. This Bugzilla is left for reference purposes.

Bug 636 - Unable to navigate back to the main site from the generated documentation

Summary:

Unable to navigate back to the main site from the generated documentation

Status:	CLOSED FIXED

Product:	PySide
Classification:	Unclassified
Component:	Documentation
Version:	HEAD
Platform:	All All

Importance:	P4 minor
Assigned To:	Hugo Parente Lima

URL:

Depends on:
Blocks:
	Show dependency tree / graph

Reported:	2011-01-24 04:46 EET by Matti Airas
Modified:	2011-02-02 15:46 EET (History)
CC List:	8 users (show)

See Also:

Attachments
ApiExtractor docs with link to PySide main page. (164.56 KB, application/octet-stream) 2011-01-24 16:19 EET, Hugo Parente Lima	Details
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.

Description Matti Airas 2011-01-24 04:46:47 EET

Reported by email:

In the generated reference documentation, it's not possible to navigate to the
main website without manually editing the URL. This is relevant because Google
searches might point to the generated docs, leaving people no easy way to
navigate further.

It should be quite simple to modify the Sphinx template so that the PySide logo
would point to http://www.pyside.org. Then, any future generated documentation
would have link in place. Then, some script magic could be used to fix existing
pages.

Comment 1 Matti Airas 2011-01-24 04:48:18 EET

I'm prioritizing this P4 because it's such a minor issue. If you're eager to
fix this sooner, just tell me, and I'll reprioritize. :-)

Comment 2 Hugo Parente Lima 2011-01-24 10:21:16 EET

Doing it in my rebel monday... :-)

Comment 3 Hugo Parente Lima 2011-01-24 10:34:22 EET

Fixed, now the pyside logo have a link to http://www.pyside.org, but you will
see them only when we generate the docs for the next release.

Commits:

apiextractor/dea7d74a75d28f09edc1ab696f238f1fbbe45fde
generatorrunner/36c7cb03f442deb4d76a94e35cd11d49a3586884
shiboken/63e2501545f8ef932414ae617f02fe73681e987c
pyside/a4d7d8f80dc21d92d41338e7e7362d9b3a1b0b3a

Comment 4 Matti Airas 2011-01-24 10:45:02 EET

(In reply to comment #3)
> Fixed, now the pyside logo have a link to http://www.pyside.org, but you will
> see them only when we generate the docs for the next release.

Thanks!

Could you provide me a sample of the new layout - I could then do a quick
script replace to apply that to the existing docs?

Comment 5 Hugo Parente Lima 2011-01-24 16:19:08 EET

Created attachment 233 [details]
ApiExtractor docs with link to PySide main page.

Yes, just two files were changes, layout.html and the css, but layout.html is
used to generate all .html pages

Comment 6 Hugo Parente Lima 2011-01-24 16:19:36 EET

s/changes/changed =]

Comment 7 Matti Airas 2011-01-25 05:52:57 EET

Thanks - fixed the existing docs by replacing the css file and the html logo
div element with a Perl (!!) oneliner. Oh, sweet irony. :-)

Comment 8 renato filho 2011-02-02 15:46:11 EET

released on beta 5