IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-09-03 20:52:55 -05:00
Code Issues Packages Projects Releases Wiki Activity
13,051 Commits 11 Branches 236 Tags
8df362154e5b6dd270b1d3343463132c02101cef
Commit Graph
100 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Timotheus Kampik 4628264551 Merge pull request #6101 from TimKam/36-docs-google-search 
#36 add Google Search how-to to FAQ
 2019-02-26 15:07:34 +01:00
Timotheus Kampik a814a2c191 #36 work in review feedback 2019-02-26 14:59:02 +01:00
Timotheus Kampik cc93ea9439 Merge pull request #6103 from nathanshammah/qutip-project 
add QuTiP to projects using sphinx_rtd_theme
 2019-02-25 20:54:39 +01:00
Timotheus Kampik d5aa1c6ccc #36 add Google Search how-to to FAQ 2019-02-24 23:03:49 +01:00
Timotheus Kampik 71fa87b7a1 Merge pull request #6032 from vedranmiletic/documentation-fixes 
Add more EXAMPLES
 2019-02-06 22:09:17 +01:00
Timotheus Kampik 877bcc2390 refine proposed changes to EXAMPLES 
* Clarify: _Eve_ is not the programming language
* Remove docutils, as the documentation example is built from a fork
* Fix syntax glitch
* Remove two examples that have not (yet) attracted significant traction
 2019-02-06 21:55:25 +01:00
Timotheus Kampik dc0120be35 Merge pull request #6018 from TimKam/6016-keep-search-results-position-fixed 
#6016 add placeholder for search summary
 2019-02-05 22:46:28 +01:00
Timotheus Kampik 8f7d5d20e1 #6016 add change summary 2019-02-05 22:26:52 +01:00
Timotheus Kampik fea44e86b8 Merge branch 'master' into 6016-keep-search-results-position-fixed 2019-02-05 22:24:58 +01:00
Timotheus Kampik d46fd7fcf0 #6016 add placeholder for search summary 
to prevent search result links from changing position when search terminates
 2019-02-04 22:53:27 +01:00
Timotheus Kampik 97d99f8302 Merge pull request #5979 from TimKam/4649-fix-search-for-filenames 
The search function considers every page a "miss"/no match if the search contains a term with length <= 2;
This is problem when users search for filenames, identifiers, et cetera.
This PR changes the behavior to be more lenient in such cases: if an additional search term is of length <= 2, it is ignored (no longer a necessary condition for a match).
 2019-01-27 20:32:56 +01:00
Timotheus Kampik 25fd9d82a6 #4649 add change summary 2019-01-27 20:12:35 +01:00
Timotheus Kampik ed12ae37e7 Merge branch 'master' into 4649-fix-search-for-filenames 2019-01-27 20:11:00 +01:00
Timotheus Kampik 0fb7f72448 #4649 polish code 2019-01-27 18:49:15 +01:00
Timotheus Kampik 1ea41ed6ca Merge pull request #3944 from fdev31/master 
add support for partial matches in js search
 2019-01-27 18:32:30 +01:00
Timotheus Kampik ebac7f7149 #4649 fix: search always returns nothing when one term is shorter than 3 2019-01-22 18:08:49 +01:00
Timotheus Kampik fa96fe4398 #1341 do not add full matches again as partial ones 2019-01-21 22:30:02 +01:00
Timotheus Kampik e48b7a52b9 Merge remote-tracking branch 'upstream/master' 2019-01-21 20:43:41 +01:00
Timotheus Kampik 2353253aa0 #1341 remove config option 
do not make partial search configurable
 2019-01-21 20:42:05 +01:00
Timotheus Kampik b1c5915850 #1341 support partial search for terms/titles 
A search word needs to be of length > 2 to be considered
Can be deactivated by setting ``html_search_partial_matching`` to ``False``
 2019-01-19 01:09:43 +01:00
Timotheus Kampik 7e45763214 Merge remote-tracking branch 'upstream/master' 2019-01-18 22:52:32 +01:00
Timotheus Kampik 0457d6ebba WIP: 5258 fix search highlight svg ff (#5265) 
* #5258 add tests for highlightText()

*  #5258 fix SVG search highlight issue in Firefox

 Use `node.parentElement.getBBox()` instead of `span.getBBox()`:

* Same highlighting behavior in Chrome, Opera

* Avoid issue with getBBox() in FF, see:
  https://bugzilla.mozilla.org/show_bug.cgi?id=612118

* Microsoft browsers to be tested

*  #5258 update package-lock.json

* #5258 test after control merge & polish

* #5258 allow for some variability in test
 2019-01-13 14:06:03 +01:00
Timotheus Kampik 64e64ffbd4 #5258 allow for some variability in test 2019-01-12 15:58:07 +01:00
Timotheus Kampik c761ec248b #5258 test after control merge & polish 2019-01-12 14:48:35 +01:00
Timotheus Kampik 6aea6f3ebc #5258 update package-lock.json 2019-01-12 14:48:05 +01:00
Timotheus Kampik 15a7f767b4 Merge branch 'master' into 5258-fix-search-highlight-svg-ff 2019-01-12 11:20:33 +01:00
Timotheus Kampik 4662a0ce4a Fix ToC (#5917) 
Intro should be first
 2019-01-10 18:08:12 +01:00
Timotheus Kampik 14b67a0464 Update Markdown doc (#5913) 
* update Markdown doc

after relase of ecommonmark version 0.5.0
 2019-01-09 16:44:00 +01:00
Timotheus Kampik 221614654f #5605 fix Chinese search index (#5611) 
generate search index for Latin words correctly if search language is Chinese
 2018-12-25 18:41:52 +01:00
Timotheus Kampik ed411fdbeb Merge pull request #5861 from TimKam/5660-version-modified-classes 
#5660 add classes for different version modications
 2018-12-24 15:12:36 +01:00
Timotheus Kampik b779975a44 Merge branch 'master' into 5660-version-modified-classes 2018-12-24 14:57:42 +01:00
Timotheus Kampik 4e3bc5dbef Merge remote-tracking branch 'upstream/master' 2018-12-24 14:57:14 +01:00
Timotheus Kampik 3addad5f2a Merge branch 'master' into 5216-update-markdown-doc 2018-12-23 17:31:01 +01:00
Timotheus Kampik 90181a16ed #5216 fix removal note 2018-12-23 17:28:44 +01:00
Timotheus Kampik 9583290653 #5216 add note regarding recommonmark version 2018-12-23 17:27:54 +01:00
Timotheus Kampik 643b5d4555 #5660 add change note 2018-12-23 17:10:51 +01:00
Timotheus Kampik edf9d210b6 #5660 adjust expected result to new classes 
Also, fix formating glitch
 2018-12-23 17:02:31 +01:00
Timotheus Kampik 98040af245 #5660 add classes for different version modications 
Generic class: ``versionmodified`
*Changed* class: ``changed``
*Added* class: ``added``
*Deprecated* class: ``deprecated``
 2018-12-23 16:44:03 +01:00
Timotheus Kampik 20c9489828 #5216 change recommonmark installation instruction 
the pypi package has not been updated since January 2016;
it is better to install from source
 2018-12-23 10:43:39 +01:00
Timotheus Kampik bc02abcb77 Merge pull request #4022 from TimKam/1618-make-search-results-reader-friendly 
#1618 make search results reader friendly
 2018-08-29 20:38:12 +02:00
Timotheus Kampik 1a801524c6 Merge branch 'master' into 1618-make-search-results-reader-friendly 2018-08-29 19:01:13 +02:00
Timotheus Kampik cbf2d8e46e #1618 document change 2018-08-28 19:34:15 +02:00
Timotheus Kampik 2aca8d0cd6 Merge remote-tracking branch 'upstream/master' into 1618-make-search-results-reader-friendly 2018-08-28 19:22:49 +02:00
Timotheus Kampik a651cbbc80 reformat example links 2018-08-27 22:36:06 +02:00
Timotheus Kampik 26bd565dee Merge branch 'master' into 1618-make-search-results-reader-friendly 2018-08-27 21:34:43 +02:00
Timotheus Kampik 3834c6a3b7 Merge pull request #5295 from TimKam/update-karma-dependency 
Update karma dependency for JS tests
 2018-08-16 21:18:41 +02:00
Timotheus Kampik e622c11185 Merge pull request #5299 from KengoTODA/add-example 
add a new book "SpotBugs manual" to EXAMPLES
 2018-08-14 10:50:38 +02:00
Timotheus Kampik 1878a52837 Update karma dependency for JS tests 2018-08-13 23:18:42 +02:00
Timotheus Kampik 3fee3648a8 Merge pull request #5292 from vividtone/add-redmine-primer-book-to-examples 
Add "Redmine Primer" to EXAMPLES
 2018-08-13 14:56:00 +02:00
Timotheus Kampik c48a612485 Merge pull request #5279 from linnekback/5278-format-example-links 
#5278: re-format links
 2018-08-09 15:20:35 +02:00
Timotheus Kampik 60be8a2684 #5278 remove duplicate & fix markup glitch 2018-08-09 14:50:58 +02:00
Timotheus Kampik 572f081d22 #5278 fix some markup glitches 2018-08-09 13:34:56 +02:00
Timotheus Kampik 5e92c4eee6 #5258 fix SVG search highlight issue in Firefox 
Use `node.parentElement.getBBox()` instead of `span.getBBox()`:

* Same highlighting behavior in Chrome, Opera

* Avoid issue with getBBox() in FF, see:
  https://bugzilla.mozilla.org/show_bug.cgi?id=612118

* Microsoft browsers to be tested
 2018-08-05 10:45:21 +02:00
Timotheus Kampik 97fd09177c #5258 add tests for highlightText() 2018-08-05 10:45:21 +02:00
Timotheus Kampik c228d5fe3c Merge pull request #5259 from CAM-Gerlach/add-example-spyder 
Add new section to examples: *Projects integrating Sphinx functionality*

and add *Spyder* to documentation examples list
 2018-08-04 11:45:21 +02:00
Timotheus Kampik ae7426fa22 List projects integrating Sphinx features 2018-08-03 23:43:32 +02:00
Timotheus Kampik 33d09e1c33 Merge pull request #5207 from TimKam/5186-js-test-infrastructure 
5186 set up JavaScript test infrastructure
 2018-07-29 08:52:37 +02:00
Timotheus Kampik afe46ef74c #5186 add tests for getQueryParameters() 
and fix test description of `urldecode()`
 2018-07-28 21:12:05 +02:00
Timotheus Kampik d14e950881 #5216 update Markdown config doc to API changes 2018-07-28 18:02:32 +02:00
Timotheus Kampik fcd0b78afa #5186 add JS test installer & runner 2018-07-24 21:17:05 +02:00
Timotheus Kampik 5ed3f0ad52 #5186 add contrib doc for JS tests 2018-07-22 20:51:14 +02:00
Timotheus Kampik 2fa382673f #5186 configure travis-ci 2018-07-22 19:19:54 +02:00
Timotheus Kampik c413e54991 Merge pull request #5209 from TimKam/5190-new-co-maintainer 
#5190 add new co-maintainer
 2018-07-22 15:08:47 +02:00
Timotheus Kampik da08da385d #5190 add new co-maintainer 2018-07-22 14:42:45 +02:00
Timotheus Kampik 5fdf81fe2d #5186 configure karma 
and add first karma test
 2018-07-22 12:27:39 +02:00
Timotheus Kampik 67cb316ba2 move templating from searchtools to documentation_options 2018-07-22 11:01:28 +02:00
Timotheus Kampik d2a15f4035 #5186 clean up JavaScript templates: doctools 
move templating from `doctools` to `documentation_options`
 2018-07-21 20:17:00 +02:00
Timotheus Kampik 395d60d49e #4255 improve conciseness 2018-07-19 21:10:16 +02:00
Timotheus Kampik 8066d36e3c #4886 clarify example/note 2018-07-18 19:40:22 +02:00
Timotheus Kampik f605012617 #4886 remove obsolete * 2018-07-17 20:40:49 +02:00
Timotheus Kampik 1c0cc20105 #1618 use file suffix config variable instead of '.html' 2018-07-17 20:15:56 +02:00
Timotheus Kampik 6bbfc3bba9 #1618 remove obsolete warning from doc 
Setting `html_copy_source` no longer affects search results
 2018-07-17 19:59:29 +02:00
Timotheus Kampik 537a69e518 #4886 adjust documentation to match actual link check behavior 2018-07-16 23:22:26 +02:00
Timotheus Kampik c126067f4e #4886 add tests 
to better cover the current link check ignore configuration
 behavior
 2018-07-16 23:17:44 +02:00
Timotheus Kampik e1ba695344 Merge branch 'master' into 1618-make-search-results-reader-friendly 2018-07-16 21:13:22 +02:00
Timotheus Kampik 94b467dbc8 #4255 clarify documentation of `startdocname` parameters. 
* Relative path from source directory

* Similar to ``master_doc`` in functionality
 2018-07-01 16:10:51 +02:00
Timotheus Kampik aa5a7e5916 #1428 further indent note 2018-04-08 13:40:23 +02:00
Timotheus Kampik 841a123c39 #1428 move/indent note 2018-04-08 13:38:53 +02:00
Timotheus Kampik 39678b7a61 #1428 update websupport API doc 
* ``staticdir`` was not correctly documented
* ```staticroot`` was not correctly documented at all
 2018-04-07 17:24:50 +02:00
Timotheus Kampik e464f6f135 #4188 update quickstart doc 2018-02-24 17:45:00 +01:00
Timotheus Kampik 20dcbd367d #4244 use more generic Python *3* examples 2018-02-24 16:45:04 +01:00
Timotheus Kampik 7aaba1758a #4244 docs: showing links & targets of Intersphinx mapping 2018-02-24 16:30:09 +01:00
Timotheus Kampik 3700a24e1a #4244 update Python version in intersphinx doc examples 2018-02-24 16:03:01 +01:00
Timotheus Kampik e2633a81a4 #3987 remove alabaster-specific sidebars 
as default sphinx-quickstart settings
 2017-10-01 22:02:55 +09:00
Timotheus Kampik 14e39adb82 #1618 make search results reader friendly 
request results as HTML instead of source files
retrieve preview snippet text from HTML
 2017-08-23 21:11:29 +02:00
Timotheus Kampik ec9f373bfa #3751 use double back ticks 2017-08-23 00:05:56 +02:00
Timotheus Kampik b9e7824033 #3987 remove alabaster-specific sidebars 
as default sphinx-quickstart settings
 2017-08-13 17:01:16 +02:00
Timotheus Kampik 22ea6d560b #3996 add note: replace hyphen with underscore if build options set in setup() command 2017-08-13 16:20:25 +02:00
Timotheus Kampik a027ee7990 #3537 set IE doc mode to Edge if not HTML5 2017-08-12 19:42:31 +02:00
Timotheus Kampik bd1a83c1ec #3548 clarify that Sphinx docs do not use sphinxdoc theme anymore 2017-08-06 21:53:39 +02:00
Timotheus Kampik 2150634508 #3799 specify missing type arguments 2017-08-06 10:20:12 +02:00
Timotheus Kampik 4f3cf402f6 #3799 use propper pluralization in (dummy) i18n call 2017-08-05 18:52:09 +02:00
Timotheus Kampik 0ed69442eb #3799 support ngettext in internal locale package 2017-08-05 18:51:12 +02:00
Timotheus Kampik 0fc80438e6 #3979 add Linux kernel doc to list of projects that use Sphinx 2017-08-05 14:21:31 +02:00
Timotheus Kampik 83155ddf7f #3978 fix typo 2017-08-05 13:50:26 +02:00
Timotheus Kampik 6413833a4f #3751 work in feedback 2017-08-02 00:20:49 +02:00
Timotheus Kampik 68fe4b2d6f #3751 document -M command line option 2017-07-16 09:50:08 +02:00
Timotheus Kampik e8cfd0f3d4 #1685 remove non-existing attributes from custom directive doc 2017-07-15 21:49:35 +02:00
Timotheus Kampik 328e57949e #1236 add note: omit underscore in internal ref 2017-07-02 15:19:47 +02:00
Timotheus Kampik 16a2367301 #2307 add :: to show markup sample, not evaluate it 2017-07-02 13:24:38 +02:00