Comments (14)
Let's take the "Table of Contents" title out of the sidebar.
from f5-sphinx-theme.
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.
I could target it with css and display none?
from f5-sphinx-theme.
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.
{{ 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.
BTW, we should probably do that as a separate commit/PR.
from f5-sphinx-theme.
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 ofrelease
.
Basically, I'm happy with everything but the sidebar. ;)
from f5-sphinx-theme.
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.
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.
A few more issues:
-
We don't have CSS defined for callouts in the text (note, info, important, caution, etc.):
-
The font size for a nested list appears to be bigger than that of the parent:
-
We should increase the min width of the sidebar, since the bullets are indented so far:
(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.
-
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 thanversion
at top of sidebar
from f5-sphinx-theme.
from f5-sphinx-theme.
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.
from f5-sphinx-theme.
The page content should not go past the blue header line / edge of the screen:
from f5-sphinx-theme.
Related Issues (20)
- RFE: moving "warning" into a block HOT 2
- Version selector is broken in staging environment
- option for "local" theme HOT 3
- Remove Index from breadcrumbs
- Add AGC config guides to header
- Add metadata
- CSS `code` formatting and wrapping
- Search is broken in v1.0.0
- Navbar issue on mobile phones HOT 1
- Breadcrumbs links are broken
- Update header - add AS3 to products
- Add Tests
- Add link to source and f5-sphinx-theme version to layout HOT 1
- Search not working in 1.0.3b4?
- Update index-gen to fix bucket name error HOT 1
- Builds failing for 1.0.3_pre-release
- htmlhintrc settings are not being picked up in builds
- GA implementation
- release and version are both showing up in the sidebar HOT 5
- Update theme for sphinx 2.0 compliance HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from f5-sphinx-theme.