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

API Documentation namespaces get cut off on smaller screen #1222

Closed
ThadHouse opened this Issue Jan 22, 2017 · 6 comments

Comments

Projects
None yet
2 participants
@ThadHouse

ThadHouse commented Jan 22, 2017

Title

API Documentation does not allow scrolling to the bottom namespaces on smaller screens

Functional impact

Cannot see docs for all namespaces

Minimal repro steps

  1. Create a documentation project with at least 30 namespaces
  2. Generate docs
  3. Host the website, on a 1080p screen you will not be able to see the bottom namespaces

Expected result

Scroll to the bottom namespaces

Actual result

Bottom namespaces are missing

Further technical details

My generated doc site can be found here. (http://robotdotnet.github.io/api/index.html)

Here is an example of what the issue looks like on my screen
screendoesntscroll

Doing some testing, it seems like the footer for the site is getting in the way and not being taken into account when determining how far to scroll. If I manually remove the footer from the HTML, everything properly displays.

@richardschneider

This comment has been minimized.

Show comment
Hide comment
@richardschneider

richardschneider Jan 22, 2017

Contributor

Precede the . (dot) with Unicode U+200B ZERO WIDTH SPACE (HTML ​) will solve the issue.

Contributor

richardschneider commented Jan 22, 2017

Precede the . (dot) with Unicode U+200B ZERO WIDTH SPACE (HTML ​) will solve the issue.

@ThadHouse

This comment has been minimized.

Show comment
Hide comment
@ThadHouse

ThadHouse Jan 22, 2017

Surrounding what . ? Is that something that needs to be changed in the doc generation? Or in my code? My generation repo is here https://github.com/robotdotnet/WPILib-Docs

ThadHouse commented Jan 22, 2017

Surrounding what . ? Is that something that needs to be changed in the doc generation? Or in my code? My generation repo is here https://github.com/robotdotnet/WPILib-Docs

@richardschneider

This comment has been minimized.

Show comment
Hide comment
@richardschneider

richardschneider Jan 22, 2017

Contributor

@ThadHouse Sorry, it's a suggestion to the docfx team for when the html is generated.

Contributor

richardschneider commented Jan 22, 2017

@ThadHouse Sorry, it's a suggestion to the docfx team for when the html is generated.

@ThadHouse

This comment has been minimized.

Show comment
Hide comment
@ThadHouse

ThadHouse Jan 23, 2017

I actually think this is a different issue than the . thing. It's not about the namespace wrapping (That's another issue I know about because of that first issue.) The actual issue is there are full namespaces hidden under the footer. Unless the . issue is causing the Javascript to calculate the window height wrong, I don't think that's actually the issue.

ThadHouse commented Jan 23, 2017

I actually think this is a different issue than the . thing. It's not about the namespace wrapping (That's another issue I know about because of that first issue.) The actual issue is there are full namespaces hidden under the footer. Unless the . issue is causing the Javascript to calculate the window height wrong, I don't think that's actually the issue.

@ThadHouse

This comment has been minimized.

Show comment
Hide comment
@ThadHouse

ThadHouse Jan 23, 2017

So more debugging, and I think I figured out the issue. Looking through the Javascript, it should be hiding the footer, however specifically on api/index.html it does not hide the footer. All other api doc files do properly hide the footer, just not index.html.

ThadHouse commented Jan 23, 2017

So more debugging, and I think I figured out the issue. Looking through the Javascript, it should be hiding the footer, however specifically on api/index.html it does not hide the footer. All other api doc files do properly hide the footer, just not index.html.

@ThadHouse

This comment has been minimized.

Show comment
Hide comment
@ThadHouse

ThadHouse Feb 15, 2017

Just rebuilt my site with 2.12.1, and this issue is fixed. Thanks!

ThadHouse commented Feb 15, 2017

Just rebuilt my site with 2.12.1, and this issue is fixed. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment