IntenseWebs/sphinx
3
0 Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-10-24 22:27:52 -05:00
Code Issues Packages Projects Releases Wiki Activity
22,460 Commits 4 Branches 238 Tags
master
Commit Graph
29 Commits
Author SHA1 Message Date
Tim Hoffmann feeee57dbe [HTML theme] sphinx13: include the project name in home link (#12700) 2024-07-28 09:50:48 +02:00
Chris Sewell ad6f659eb2 [docs] Add Previous/Next links after content (#12466) 2024-06-27 14:58:50 +02:00
Chris Sewell a1bb165685 [docs] Add Github repo icon-link to topbar (#12462) 
Add a link to sphinx-doc/sphinx, via an icon on the right of the top-bar
 2024-06-22 20:48:18 +02:00
Chris Sewell bcf32428c8 [docs] Improve sidebar (#12461) 
- Remove "Site navigation" header
  - this is already contextually clear (especially since separators were added in #12439)
- Hide "On this page" if `display_toc is False`
- Format "On this page" header similar to top-level site-nav sections
 2024-06-22 15:32:06 +02:00
Thomas Weißschuh d5bdabdd80 themes: Don't duplicate "navigation" in aria-label (#12422) 
The word "navigation" is not supposed to be included as part of the aria-label attribute:
https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/navigation_role
 2024-06-17 12:50:34 +02:00
Shengyu Zhang 9c3b50b31c Avoid hard-coding 'index' for the master document in templates (#11801) 2023-12-28 07:05:14 +00:00
Adam Turner 8878bee000 Replace the header image with a new SVG logo 2023-10-04 16:56:46 +01:00
Stefanie MolinandAdam Turner e09d02e440 Allow `copyright` to contain multiple entries (#10983) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2023-05-11 22:43:48 +01:00
Tim Hoffmann b430e05285 Create a 'search field' component for themes (#11045) 
``searchfield.html`` is similar to the existing ``searchbox.html``, but does not
have the heading "Quick Search". Instead, it uses "Search" as a placeholder
text. This gives a cleaner and less cluttered appearance.

The searchfield component is added to the basic theme and thus can be used
in any derivative theme. It is not used by default for backward compatibility.

The searchfield compenent is made the default in the sphinx13 theme.

CSS changes ensure that the top of the search field is aligned with the
top of the main content.
 2023-04-21 02:02:04 +01:00
Chris HoldgrafandAdam Turner eb0a6c574f Update documentation structure and theming (#10677) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2022-07-18 22:48:28 +01:00
Adam Turner 9112cfeb8d Refresh the Sphinx13 theme (#10652) 2022-07-10 22:48:15 +01:00
Adam Turner 3b01fbe2ad Drop JavaScript Frameworks (#10028) 
* Delete jQuery and underscore.js

* Move underscores.js setup to searchtools.js

* Update jQuery.url(en|de)code

* Update jQuery.getQueryParameters

* Firefox bug is no longer present

xref https://bugzilla.mozilla.org/show_bug.cgi?id=645075#c49

* Update jQuery.fn.highlightText

* Use enum instead of magic number

* Update test descriptions to remove obsolete jQuery reference

* Update Documentation.getCurrentURL

* Revert accidental fix of Documentation.getCurrentURL

* Update Documentation.initOnKeyListeners

* Update Documentation.hideSearchWords

* Update Documentation.highlightSearchWords

* Update Documentation.initDomainIndexTable

* Use arrow functions and const

* Replace $(document).ready

* Strict mode

* Move Documentation.hideSearchWords next to Documentation.highlightSearchWords

* Update translation functions in Documentation

* Replace $(document).ready in searchtools.js

* Update Scorer

* Update Search.hasIndex, Search.deferQuery, Search.stopPulse

* Prefer window.location

* Update Search.init

* Update Search.loadIndex

* Update Search.setIndex

* Update Search.startPulse

* Add _escapeRegExp

* Update Search.makeSearchSummary

* Update Search.htmlToText

* Update Search.performSearch

* Factor out _displayNextItem

* Update Search.query

* Update Search.performObjectSearch

* Update Search.performTermsSearch

* Remove underscores.js setup

* Use Sets

* Update test configuration

* Fix test failures

* Drop unused make/get URL functions

* Strict mode in searchtools.js

* Remove outmoded check for jQuery and underscore.js

* Ran prettier

prettier --print-width 120 --no-semi --quote-props as-needed --no-bracket-spacing --arrow-parens avoid --write sphinx/themes/basic/static

* Remove more references to jQuery and underscore.js

* Remove jQuery and underscore.js licences

* Update classic theme for no jQuery

* Update all other themes for no jQuery

* Restore jQuery & underscores.js to Sphinx themes

Enables a more gradual deprecation

* Added deprecation note to CHANGES

* Run prettier with defaults

* Update deprecation message to include extensions, note that sources must be copied

* oops

* Address Pradyun's feedback

* Forgot this one

* `let` doesn't work, as it is scoped to the block...

* Remove missed jQuery in sphinx13 theme
 2022-01-30 20:27:12 +01:00
Thibaud Colas 00e2c2e250 Fix broken "Extend" link in site header 
Spotted while navigating https://www.sphinx-doc.org/en/master/.
 2021-02-04 22:04:17 +00:00
Stephen Finucane f40bbee221 docs: Remove the 'develop' guide 
This contained a list of extensions, along with general contributing
information and pointers on how to develop your own extensions. The list
of extensions was very old, referenced the dead BitBucket repo and was
really not very helpful, while the contributing and development
information was just pointers to other, better documentation. Remove the
document wholesale and update any pointers we have to it to other,
better docs.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-02 22:02:19 +01:00
Matthias Geier fc78f09441 DOC: Use html_baseurl 2020-04-17 17:01:48 +02:00
Jon Dufresne e6915baae8 Remove redundant type="text/javascript" from <script> elements 
In HTML5, <script> elements default to MIME type text/javascript. The
HTML5 living standard and MDN recommend against including the attribute.

From https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script#attr-type

> The HTML5 specification urges authors to omit the attribute rather
> than provide a redundant MIME type.

From https://html.spec.whatwg.org/#the-script-element

> Authors should omit the type attribute instead of redundantly setting
> it.
 2019-12-15 07:52:40 -08:00
Takeshi KOMIYA 1b1ebd2c75 A happy new year! 2019-01-02 16:00:30 +09:00
Takeshi KOMIYA 69624bffa7 doc: Fix filename 2018-04-12 00:49:31 +09:00
Takeshi KOMIYA d8c107a61b Fix #4744: Add canonical URL to docs 2018-03-21 00:01:44 +09:00
Takeshi KOMIYA f1f6ca8cc9 Merge branch 'happy_new_year' into master 2018-01-01 01:09:17 +09:00
Takeshi KOMIYA 2426cedb8b A happy new year! 2018-01-01 01:06:58 +09:00
Alex Gaynor f9250e198b Switched stylesheet for font to HTTPS to avoid mixed content issues 2017-09-24 14:02:53 -04:00
Takeshi KOMIYA c57e47e042 Year++ 2017-03-26 11:49:34 +09:00
Yoshiki Shibukawa 90b3c79895 fix html entity to fix epub error 2016-08-09 16:58:56 +09:00
Georg Brandl 46d7e8558e Obligatory copyright update. 2016-01-14 22:54:04 +01:00
Georg Brandl 567d52f199 all: update copyright 2015-01-03 21:36:32 +01:00
Georg Brandl e030031321 Update copyright year. 2014-03-01 08:18:16 +01:00
Robert Lehmann 529519275e Fixed W3C Validator errors in index page. 2014-02-05 15:06:59 +01:00
Georg Brandl 0939d6fcdb New doc design "sphinx13". 2013-01-18 23:17:11 +01:00