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: utilize smartmenus #6914

Merged
merged 1 commit into from
Apr 25, 2017
Merged

Conversation

miri64
Copy link
Member

@miri64 miri64 commented Apr 15, 2017

As of version 1.8.12 Doxygen uses smartmenus for the navbar on top. Our design should do so as well (while also supporting <1.8.12 Doxygen output).

Fixes #6910.

@miri64 miri64 added Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors) Area: doc Area: Documentation labels Apr 15, 2017
@miri64 miri64 added this to the Release 2017.04 milestone Apr 15, 2017
@miri64 miri64 added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Apr 15, 2017
@jnohlgard
Copy link
Member

Will test this after the weekend.

Copy link
Member

@jnohlgard jnohlgard left a comment

Choose a reason for hiding this comment

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

Fixes the problem for me on Doxygen 1.8.13.
However, was the doc/doxygen/index.html file added by mistake?

@jnohlgard
Copy link
Member

Discovered a minor issue, the arrows for expanding the tree in the side bar are overlapped by the text.

image

@miri64
Copy link
Member Author

miri64 commented Apr 17, 2017

Fixes the problem for me on Doxygen 1.8.13.
However, was the doc/doxygen/index.html file added by mistake?

Fixed

Discovered a minor issue, the arrows for expanding the tree in the side bar are overlapped by the text.

image

Can you send me the html files again? I did not observe this issue. :-/

miri64 added a commit to miri64/RIOT that referenced this pull request Apr 18, 2017
@jnohlgard
Copy link
Member

I managed to locate the problem. It seems like the design update is switching the box model from content-box to border-box, which causes the 16px width arrow span to include the padding, which is set by navtree.js to (16px * indent_level). If we can switch back to the default content-box model then everything should be OK again, I think. I'm not well versed in modern web technologies so I couldn't find where to change it, but there are mentions of border-box when I git grep the doc/doxygen/src tree.

@jnohlgard
Copy link
Member

Found some more info:
http://stackoverflow.com/questions/18854259/why-did-bootstrap-3-switch-to-box-sizing-border-box

Bootstrap is simply incompatible with Doxygen without patching templates/html/navtree.js in the Doxygen sources.

The navtree looks fine on my side when removing the box-sizing specifiers in bootstrap.min.js, but I don't know if it will have other side-effects on the layout when the dimensions in CSS are not as expected.

@miri64
Copy link
Member Author

miri64 commented Apr 20, 2017

Actually I already fixed that for the current version at doc.riot.org (that's what this is about). Please just send me your sources and I'll fix that again.

@miri64
Copy link
Member Author

miri64 commented Apr 20, 2017

Alternatively, have a look with your browser's "Inspect" function which selector sets the this?

@jnohlgard
Copy link
Member

The selector is * found in bootstrap.min.js

@miri64
Copy link
Member Author

miri64 commented Apr 20, 2017

Then let's try this with a compiled result again, if this isn't a problem for you.

@miri64
Copy link
Member Author

miri64 commented Apr 20, 2017

(which browser are you using?)

@kaspar030
Copy link
Contributor

whats the state here?

@miri64
Copy link
Member Author

miri64 commented Apr 21, 2017

I need @gebart's compiled doc to fix the issue he pointed out.

@kaspar030
Copy link
Contributor

Would it make sense to fix this for .04?

@miri64
Copy link
Member Author

miri64 commented Apr 21, 2017

It does not affect the build doc at doc.riot-os.org at the moment, and even then is just about some broken styling, so I wouldn't give it that much priority.

@miri64
Copy link
Member Author

miri64 commented Apr 21, 2017

(+ there is no release-based version of doc.riot-os.org anyway).

@jnohlgard
Copy link
Member

replacing the selector line at https://github.com/RIOT-OS/RIOT/blob/master/doc/doxygen/src/css/riot.css#L92-L95 by

#nav-tree img, #nav-tree span {

seem to fix it on my side.

@miri64 miri64 force-pushed the doc/fix/smartmenus branch from f0ff77a to 7a3f500 Compare April 22, 2017 11:20
@miri64
Copy link
Member Author

miri64 commented Apr 22, 2017

Rebased and fixed in riot.less (and recompiled riot.css)

@@ -202,7 +206,7 @@ div.line.glow {
}
span.lineno {
background-color: transparent;
border-right: 3px solid #e3e3e3;
border-right: 2px solid #e3e3e3;
Copy link
Member Author

Choose a reason for hiding this comment

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

Seems like there was a difference in here ;-)

Copy link
Member

@jnohlgard jnohlgard left a comment

Choose a reason for hiding this comment

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

ACK

@miri64 miri64 force-pushed the doc/fix/smartmenus branch from 7a3f500 to 66b5ada Compare April 22, 2017 18:02
@miri64
Copy link
Member Author

miri64 commented Apr 22, 2017

Squashd

@jnohlgard
Copy link
Member

Running './dist/tools/whitespacecheck/check.sh master' x
Command output:

	doc/doxygen/src/css/jquery.smartmenus.bootstrap.css:31: space before tab in indent.
	+ 	border-style: solid;
	doc/doxygen/src/css/jquery.smartmenus.bootstrap.css:123: new blank line at EOF.
	doc/doxygen/src/js/jquery.smartmenus.bootstrap.min.js:4: new blank line at EOF.
	doc/doxygen/src/js/jquery.smartmenus.min.js:4: new blank line at EOF.
	doc/doxygen/src/js/menu.js:30: trailing whitespace.
	+    /* code adapted from original menu.js of Doxygen, but made 
	ERROR: This change introduces new whitespace errors

@miri64 miri64 force-pushed the doc/fix/smartmenus branch from 66b5ada to ee18d1e Compare April 24, 2017 11:41
@miri64
Copy link
Member Author

miri64 commented Apr 24, 2017

Fixed and amended immediately

@jnohlgard
Copy link
Member

Still one white space error according to Murdock

@miri64 miri64 force-pushed the doc/fix/smartmenus branch from ee18d1e to b092179 Compare April 25, 2017 07:36
@miri64
Copy link
Member Author

miri64 commented Apr 25, 2017

Fixed and amended

@jnohlgard jnohlgard merged commit 032c3b6 into RIOT-OS:master Apr 25, 2017
@jnohlgard
Copy link
Member

Murdock is fine, go!

@miri64 miri64 deleted the doc/fix/smartmenus branch April 25, 2017 09:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants