kai687 / sphinxawesome-theme Goto Github PK

Data-tooltips for tooltips and data-expanded or something like that for menu state toggles. This should reduce javascript. Maybe this can also help with the collapsible navs issue #52 .

Thee navbar should be rendered by default show_navbar=True but one should be able to override this.

If the navbar is not rendered, check, that everything still works on mobile (the menu button must be hidden then as well).

the class is pre.literal-block. The only challenge is that the code blocks are pre elements wrapped in div.highlights and the literal blocks are not.

Landing page contains duplicate text about usability improvements. Cloning from GitHub samp directive is not rendered correctly.

Strong/bold text has currently font-weight: bolder which probably should just get redefined to medium.

Two options:

• define every strong/bold to font-medium
• define only definition list titles to be medium, and add the semibold font back into the mix

With the latest change, the theme needs to be enabled as an extension.
For the netlify build, we need to add the path to the theme so that the
extension can be found locally.

I need to only bundle the used fonts. and create the font face rule myself, unless I find a way to strip all the unused fonts from the javascript import.

For code blocks, the copy button is attached to the .highlight class and the scrolling happens on the child, the actual pre. For literal blocks, there is no wrapper class, so the copy button moves when scrolling to the right.

I need to either wrap the literal blocks in a container class, to add the copy button, or leave it off for now.

This should be easier with a more powerful code directive (#15)

As much as possible, use colored backgrounds instead of outlines for focus: styles. The outlines are hard to see in some cases. If colored backgrounds are not enough, use focus:shadow-outline

and maybe autolabel?

After clicking on the code copy button, voice over reads everything. I need to find a way to prevent that.

Whenever I push changes to master and they pass the tests, these changes should automatically be merged into the docs branch.

It doesn't look super bad right now, but can be improved.

I need to either find a different way of specifying the position of the element, so that the tooltip stays near the element, or I need to hide it whenever scrolling happens or after a timeout. The issue is that touch events apparently keep the focus while mouse scrolling does not.

The margins and paddings absolutely break the tabular layout.

If show_nav: False, the toctree links in the main content area are unstyled.

On small screens, when clicking on any link that is on the current page, the navigation menu does not close, since there is no new page request.

On homepage, the footer isn't sticky anymore. I thought this was working

• make navigation tree collapsible and expandable. Users should be able to navigate to a specific subsection on a page.
• like in other themes, individual subsections on a page should also be marked as active when scrolling

Seems like a vertical bar | would be more space saving than a – in tabs, so let's change that.

Apparently, I can use this option to define the character for the permalink. Then I don't have to use this weird hack with hiding one character and showing another. Plus it would make this configurable.

If you want to use it in the documentation, you also need to add it to the extension list.

I could think of a way to automatically add it, since we will always install it anyway.
If import fails for some reason (someone uninstalled it, etc.) I can skip it but it should
work from within the theme.

Didn't I make the footer sticky? It doesn't appear to be the case.

Added difficulty for the top margin of the h1 headline.

The search results and the 'copyright info' are not wrapped at max-width like the main content area.

Should not be full screen. It should slide in from the bottom, covering only enough space to show the search input and the label, maybe about a third or so.

I was going back and forth on this. It doesn't matter much, but as an analogy to the URL in a browser, the slash is a better representative. Maybe implement it as a configuration option as well.

In "How to install a theme" explain that YOUR_GITHUB_USERNAME should be replaced.

Remove the heavier font weight and tracking from the navigation menu links. This reduces the visual weight and makes the page overall calmer.

On wide screens, I could increase the space on the left side of the main area a bit. If it's easy to implement (e.g. like the Google Developer docs have it), I think it would improve the experience.

In the search pane, Enter Search term hurts my eyes... Decide on capitalization and apply it consistently.

See the Google Developer documentation. I also should change the link text to 'Copy link to this section:

It would be nice to add the project's name to the title tag for each page.

Dependabot couldn't find a package.json for this project.

Dependabot requires a package.json to evaluate your project's current JavaScript dependencies. It had expected to find one at the path: /theme-src/package.json.

If this isn't a JavaScript project, or if it is a library, you may wish to disable updates for it from within Dependabot.

View the update logs.

• Include the necessity to provide a heading or caption to tocs when show_nav is false.
• first sentence of how to configure is superfluous
• option lists instead of definition lists?
• the description of the samp directive also reads very odd...

the input doesn't have an aria-label. Also, we have two times the same ID for the search-pane thing and the search input field.

The semibold font weight of Roboto is only used for the 'permalink' character. It looks as well with the 'medium' style, so we can get rid of the semibold font style alltogether.

It would be nice to be able to link straight to admonitions. It's not recommended to put in anything useful in there,
but it would be cool to add permalinks to the caption of admonitions as well. That may be useful for security-relevant admonitions.

I want to be able to make italicized output of variables in code block. The parsed literal directive should allow that, but I'm not sure yet how to integrate that into a code-block directive.

The search field from the full-height search pane looks strange at least on a mobile Chrome. It appears as if I applied 'rounded-full' which does not show up on Desktop browsers, also not in responsive mode.

Instead of putting the svg for the icons straight into the templates, I could use webpack to inline them in the css as background images. This would keep templates cleaner and separated from assets like icons.

It's bad that the snackbar has two completely separate functions.

1. The display of messages from the website
2. Clicking to remove highlighted words.

The second function requires an action but it visually represented the same way. There must be a better visual clue that a user action is required.

On small screens the project's title should also be a link to the homepage.

It seems like I can't really call this theme 'simple', given the amount of features. It would be a good idea to highlight a few of what I consider distinct features of this theme on the README. Also go over the project description in the pyproject.toml file at the same time.

It just makes more sense to have this on by default if it's the recommended setting. The Read The Docs theme also does that by default, so switching between the two themes should be easier.

To be more compatible with other Sphinx themes, I need to implement a few more checks if information is present, e.g. if no copyright info is present, etc.

Maybe I can also add the Sphinx build information.

Probably have to default back to 'project' or something else. The same is also happening with the alabaster theme, so it doesn't look like a bug to me.