IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
21,033 Commits 2 Branches 219 Tags 163 MiB
dd77f85149
Commit Graph

102 Commits

Author SHA1 Message Date
Matthias Geier
65fd5be20d
Use the 'toctree-wrapper' class for the `sphinx13` theme (#11129) 2023-08-14 23:40:42 +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
Takeshi KOMIYA
b1df3fa94b
Merge pull request #9287 from ssbarnea/fix/irc 
Document new irc channel location
 2021-12-16 01:33:53 +09:00
Rafael Fontenelle
ca74c94610
doc: fix grammar of possessive of plural noun 2021-10-03 11:04:10 -03:00
usaturn
c56a37e4d5 fix link of code of conduct 2021-07-17 17:38:27 +09:00
Juan Luis Cano Rodríguez
5e7c011b92 Fix broken link to third-party extensions 2021-06-16 18:32:02 +02:00
Sorin Sbarnea
82d769c56e Document new irc channel location 2021-06-01 11:09:19 +01:00
Juan Luis Cano Rodríguez
70ee9bcd6a Tutorial link in front page, audience, objectives, and prerequisites 2021-05-26 21:25:38 +02:00
igo95862
6c5f77c689
doc: Upgrade pygments.org links to HTTPS 2021-05-16 15:53:58 +03:00
igo95862
e67c9e5df1
doc: Upgrade docutils.sourceforge.io links to HTTPS 
Also change any docutils.sourceforge.net link to io
top level domain.
 2021-05-16 15:53:49 +03: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
Stephen Finucane
d3021f644f docs: Add contributing document 
This completes the migration from the CONTRIBUTING document to the new
in-tree contributing guide. The CONTRIBUTING document itself is
temporarily removed so that git will correctly mark the document as
having been moved. A future change will re-add this document as well as
rework the new contributing document.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-02 12:08:34 +01:00
Tetsuo Koyama
f3aae09231
💝 Let's say thanks to all translator 2020-03-28 17:56:35 +09:00
Takeshi KOMIYA
7faeb793e2 Close #6658: Add CODE_OF_CONDUCT (#6661) 
* Close #6658: Add CODE_OF_CONDUCT

* #6658 refine CoC

* Base on Django CoC: https://www.djangoproject.com/conduct/
* Simplify: we are a smaller project and can be more concise
* Add to ToC
* Link from README
* Link from index page
 2019-10-06 16:41:37 +02:00
juh
6be9556904
adding German book about Sphinx 
Adding a link to the authors bookpage.
 2019-05-02 11:49:23 +02:00
Takeshi KOMIYA
f14d60dcd2
Merge pull request #5096 from tk0miya/update_docs 
doc: update URL of PDF and EPUB
 2018-06-21 01:29:42 +09:00
Takeshi KOMIYA
fd8e0be57a Merge branch '1.7' 2018-06-19 23:39:23 +09:00
Takeshi KOMIYA
0e8fb2dd25 doc: update download URL for PDF and EPUB 2018-06-17 16:55:18 +09:00
Takeshi KOMIYA
248869e2db doc: Use badge to show latest release 2018-06-17 16:45:58 +09:00
Jon Dufresne
365c93f227 Update all pypi.python.org URLs to pypi.org 
For details on the new PyPI, see the blog post:

https://pythoninsider.blogspot.ca/2018/04/new-pypi-launched-legacy-pypi-shutting.html
 2018-04-18 19:51:48 -07:00
Stephen Finucane
ff579b3c66 doc: Add "quickstart" doc to usage guide 
This is simply the former 'tutorial' document renamed. A number of
references need to be updated, so this is done.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-02-26 11:36:46 +00:00
Danish Prakash
0fe14c3e3b
potential typo 
`You can also download PDF/EPUB versions of the Sphinx documentation: a PDF version generated from the LaTeX Sphinx produces, and an EPUB version.`

Either a typo or maybe wrong sentence structure.
 2018-02-06 11:09:48 +05:30
Kurt McKee
beefd445c1 Convert doc HTTP links to HTTPS, even in documentation examples 
A small number of URL's redirected, or were stale but had obvious
alternatives. These have been updated. For example, a Google style
guide for Python was no longer available at googlecode.com, and
Paver docs are now at readthedocs.io.
 2018-01-20 16:50:35 -06:00
Jon Dufresne
cc3abba171 Prefer https & readthedocs.io instead of readthedocs.org for links 
Read the Docs moved hosting to readthedocs.io instead of
readthedocs.org. Fix all links in the project.

For additional details, see:

https://blog.readthedocs.com/securing-subdomains/

> Starting today, Read the Docs will start hosting projects from subdomains on
> the domain readthedocs.io, instead of on readthedocs.org. This change
> addresses some security concerns around site cookies while hosting user
> generated data on the same domain as our dashboard.
 2018-01-07 09:10:27 -08:00
Tim Hoffmann
bbfcb2443d cleanup formatting of some sidebar items 2018-01-06 17:49:27 +01:00
Takeshi KOMIYA
bd66ffc1fa Fix the unreleased version number is shown (refs: #3678, #3027) 2017-04-28 01:19:01 +09:00
shimizukawa
732bb213ca add link to Changes in toppage 2016-12-15 21:53:13 +09:00
Yoshiki Shibukawa
1742d2ea02 fix inter document link 2016-09-02 16:37:29 +09:00
Yoshiki Shibukawa
792d154b1a fix sphinx document's style to satisfy xhtml standard 2016-09-01 23:54:54 +09:00
Yoshiki Shibukawa
0ef331a4c7 fix sphinx document's template not to have link to genindex for epub result 2016-08-23 08:02:54 +09:00
Takeshi KOMIYA
8a9459b308 Merge branch 'stable' 2016-08-09 23:19:11 +09:00
Yoshiki Shibukawa
90b3c79895 fix html entity to fix epub error 2016-08-09 16:58:56 +09:00
Eric Holscher
7acf202842 Clean up the prose on the main site page 2016-03-15 10:53:20 -07:00
Georg Brandl
5e8642983b Fixup links in the documentation. 2016-02-13 16:00:46 +01:00
shimizukawa
09b931745d Switch links for pdf version documentation to on ReadTheDocs. 2016-01-10 11:18:55 +09:00
shimizukawa
ff01b78412 Remove version specific installation procedure and link to stable/latest document page because sphinx site has been moved to ReadTheDocs so the information is obsoleted. 2016-01-10 11:18:44 +09:00
Robert Lehmann
f323b60641 Explicitly mention sphinx-users mailing list 
This should now answer searches for "mailing list" and "sphinx-", in case users just skim the Web site.

I have checked this in a Web browser and it looks good IMO (box not overfull.)
 2015-06-24 21:13:24 +09:00
shimizukawa
cdc4f5d8bb fix http/https 2015-02-28 01:10:03 +09:00
shimizukawa
720ef3dafe display pip install method for develop version 2015-02-25 16:25:50 +09:00
shimizukawa
b0d40ea22c Closes #1735: Use https://doc.python.org/ instead of `http protocol. It was used for sphinx.ext.intersphinx` and some documentation. 2015-02-23 04:20:35 +00:00
Georg Brandl
91887b0183 Merge branch 'stable' 2015-01-02 13:51:31 +01:00
Georg Brandl
a84e036622 development process updates: bb->gh, hg->git 2015-01-02 13:49:38 +01:00
Georg Brandl
7aa43488ea add a paragraph about sphinx-contrib on the front page 2014-09-22 10:20:02 +02:00
Georg Brandl
772dbbd4d9 Fix the docs index sidebar for unreleased versions. 2014-09-22 09:58:09 +02:00
Matt Hickford
580458fce1 Explain how to install Sphinx with pip (rather than easy_install). Fixes #1447 2014-09-14 17:13:52 +00:00
Takayuki Shimizukawa
0cfb00db79 Add documentation to make contribution easier. 2014-08-31 00:02:01 +09:00
Robert Lehmann
529519275e Fixed W3C Validator errors in index page. 2014-02-05 15:06:59 +01:00
Georg Brandl
9d25862700 add link to "write the docs", move hosting chapter to home page 2014-01-12 12:44:36 +01:00
Georg Brandl
de2e47bfce IRC channel update. 2013-09-16 09:16:08 +02:00