Giter VIP home page Giter VIP logo

Comments (14)

jputrino avatar jputrino commented on May 26, 2024

Let's take the "Table of Contents" title out of the sidebar.

from f5-sphinx-theme.

swormke avatar swormke commented on May 26, 2024

This is a good thing to do, but we need to add our own sidebar templates I believe for the localtoc and globaltoc. One of those contains this Table of Contents header I am assuming because right now it is using the default sidebar templates from sphinx-doc.

        {%- if sidebars != None %}
          {%- for sidebartemplate in sidebars %}
            {%- include sidebartemplate %}
          {%- endfor %}
        {% endif %}

from f5-sphinx-theme.

recursivelycurious avatar recursivelycurious commented on May 26, 2024

I could target it with css and display none?

from f5-sphinx-theme.

swormke avatar swormke commented on May 26, 2024

It is just as easy to add our own, because it is not likely that this will be the last thing we need to add in here.

from f5-sphinx-theme.

swormke avatar swormke commented on May 26, 2024

{{ toc }} and {{ toctree }} is all that you need in them, and maybe a custom

above it if @jputrino wants it to say something other than table of contents..

from f5-sphinx-theme.

swormke avatar swormke commented on May 26, 2024

BTW, we should probably do that as a separate commit/PR.

from f5-sphinx-theme.

jputrino avatar jputrino commented on May 26, 2024

2017-03-01_11-44-47
Looks pretty good! A few nitpicks:

  • Can the font in the sidebar be smaller?
  • I'd like the search bar to be aligned with the text above it instead of indented.
  • I'd like to change the version number in the sidebar to call html_title instead of release.

Basically, I'm happy with everything but the sidebar. ;)

from f5-sphinx-theme.

jputrino avatar jputrino commented on May 26, 2024

Future dev:

  • add expand/collapse functionality to sidebar items so users can select from any of a doc's subheadings

see https://jqueryui.com/accordion/#collapsible

from f5-sphinx-theme.

swormke avatar swormke commented on May 26, 2024

Possibly take the Quick search header out and put "Search" in the search box in grey.
Add the title + release in the side bar not just the title.

from f5-sphinx-theme.

jputrino avatar jputrino commented on May 26, 2024

A few more issues:

  • We don't have CSS defined for callouts in the text (note, info, important, caution, etc.):
    2017-03-01_15-23-06
    2017-03-01_15-22-45

  • The font size for a nested list appears to be bigger than that of the parent:
    2017-03-01_15-22-37

  • We should increase the min width of the sidebar, since the bullets are indented so far:
    2017-03-01_15-28-30
    (the sidebar is compressed when the screen is resized to a smaller frame or when a code-block is really long and takes up more on-screen real estate)

from f5-sphinx-theme.

recursivelycurious avatar recursivelycurious commented on May 26, 2024
  • search box aligned left

  • sidebar font size 14px

  • padding for ul on sidebar reduced

  • resolve @media breakpoints for width of sidebar -- odd behavior at 1201px

  • remove quick search header and add placeholder text

  • use html_title rather than version at top of sidebar

from f5-sphinx-theme.

jputrino avatar jputrino commented on May 26, 2024

add some padding in tables:
2017-03-03_13-42-38

from f5-sphinx-theme.

jputrino avatar jputrino commented on May 26, 2024

in localtoc, we need a header specifying that the links shown are for the current document. In this image, I've moved localtoc ahead of globaltoc.

This won't really be an issue once we have an expandable globaltoc.

2017-03-06_17-00-14

from f5-sphinx-theme.

jputrino avatar jputrino commented on May 26, 2024

The page content should not go past the blue header line / edge of the screen:
2017-03-09_12-01-25

from f5-sphinx-theme.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.