IntenseWebs/sphinx
3
0 Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-10-13 00:42:11 -05:00
Code Issues Packages Projects Releases Wiki Activity
10,083 Commits 11 Branches 236 Tags
cb4b7177d85c31dc6d49eb01b99fb04310aa12f8
Commit Graph
10083 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Stephen Finucane cb4b7177d8 doc: Create usage guide section 
Start structuring our docs a little better starting with a usage guide.
There are a number of changes happening here. We're going to start with
the installation guide, which is simply moved to the appropriate
subdirectory.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-02-10 16:22:44 +00:00
Stephen Finucane 4fa7d6037c doc: Rework "install" document 
This is a large rework of the installation guide. There are a couple of
changes necessary:

- 'Mac OSX' is replaced by 'macOS'
- PyPI installation steps are moved to their own section
- Instructions are no longer provided for installing Python on Windows:
instead, we refer to the other, better-maintained guides.

In addition, there are a number of cleanup items.

- Some paragraphs are reworded or clarified
- Semantic markup is added where possible
- Everything is wrapped to ~80 characters

A number of TODOs are inserted. These will be resolved separately.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-02-10 16:22:40 +00:00
Takeshi KOMIYA e84ba569a2 Merge branch '1.7-release' 2018-02-10 15:46:48 +09:00
Takeshi KOMIYA e420d259d5 Update gitignore 2018-02-10 12:10:36 +09:00
Takeshi KOMIYA 506cc44d4a Merge pull request #4571 from tk0miya/4560_i18n_compilation_problem 
Fix i18n: message catalogs are not compiled when specific build (refs: #4560)
 2018-02-10 12:08:26 +09:00
Takeshi KOMIYA 0f1168308b Merge branch '1.7-release' into 4560_i18n_compilation_problem 2018-02-10 11:53:14 +09:00
Takeshi KOMIYA 9eff2a5679 Merge pull request #4585 from vedranmiletic/documentation-fixes 
EXAMPLES: move Arcade to rtd section, add aria2
 2018-02-10 11:31:01 +09:00
Vedran Miletić 7dc1b14b91 EXAMPLES: move Arcade to rtd section, add aria2 2018-02-10 01:06:03 +01:00
Takeshi KOMIYA acee7b8a55 Merge pull request #4584 from Zac-HD/doctest 
Report true file location of doctests
 2018-02-09 22:12:55 +09:00
Zac-HD b62628f678 Avoid misreporting line number 2018-02-09 11:05:26 +11:00
Zac-HD 68bccb01ac Get correct filename for each doctest block 
This is complicated because doctests may be included from other files,
eg. dosctrings in a Python module.
 2018-02-09 11:05:25 +11:00
Zac-HD 50823c4b37 Fix type hint, minor style improvements 2018-02-09 10:39:25 +11:00
Zac-HD 973f2680d6 Add ext.autodoc + ext.doctest test root 2018-02-09 10:39:25 +11:00
Takeshi KOMIYA c21065e278 Merge pull request #4580 from tk0miya/remove_funcion_based_directive_tests 
test: Remove function based directives
 2018-02-08 21:50:14 +09:00
Takeshi KOMIYA a9f370bc12 test: Remove function based directives 2018-02-08 13:50:25 +09:00
Takeshi KOMIYA afbd27f996 Fix i18n: message catalogs are not compiled when specific build (refs: #4560) 
sphinx-build skips message catalog builds if specific filename are given
as arguments.
 2018-02-08 12:44:15 +09:00
Takeshi KOMIYA acbf62fb6d Merge pull request #4578 from dannguyen/patch-1 
added "Hitchhiker's Guide to Python" to EXAMPLES
 2018-02-08 11:56:08 +09:00
Dan Nguyen 678999fba2 added "Hitchhiker's Guide to Python" to EXAMPLES 2018-02-07 18:24:54 -08:00
Takeshi KOMIYA c2cd4f6a40 Merge pull request #4566 from tk0miya/add_branch_models_to_contributing 
docs: mention about branch model (refs: #4398)
 2018-02-07 22:35:18 +09:00
Takeshi KOMIYA fb257ac449 docs: mention about branch model (refs: #4398) 2018-02-07 22:14:18 +09:00
Takeshi KOMIYA 64945bc793 Merge pull request #4558 from tk0miya/refactor_application 
Refactor application
 2018-02-07 22:11:32 +09:00
Takeshi KOMIYA 533fa55936 Merge pull request #4561 from stephenfin/cleanup 
Cleanup
 2018-02-07 22:08:41 +09:00
Stephen Finucane d35cda9943 util: Mark deprecated functions with warning 
This ensures the functions can actually be removed as expected.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-02-07 11:26:59 +00:00
Takeshi KOMIYA 6edf175c91 Merge pull request #4570 from cocoatomo/unify-term 
Unify expression of terms in the log message
 2018-02-07 10:57:34 +09:00
cocoatomo 9b39e5e87f Unify expression of terms in the log message 2018-02-07 10:52:28 +09:00
Takeshi KOMIYA 465eb05425 Merge pull request #4569 from cocoatomo/minor-typo 
Insert a space after the comma in the message
 2018-02-07 10:27:52 +09:00
cocoatomo 0be75fd029 Insert a space after the comma in the message 2018-02-07 10:23:43 +09:00
Takeshi KOMIYA 301aee4916 Drop function based directive support 2018-02-07 09:20:47 +09:00
Takeshi KOMIYA 51a0f709b5 Update sphinx.pot 2018-02-07 09:17:15 +09:00
Stephen Finucane 05f851fa19 trivial: Remove 'tests/etree13' 
This vendored code had no callers in modern Sphinx and has not been
needed since Python 2.5, which included the ElementTree API [1], was
released. It can be removed in its entirety.

[1] https://docs.python.org/2/library/xml.etree.elementtree.html

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-02-06 20:15:25 +00:00
Takeshi KOMIYA 06a12db39b Merge pull request #4567 from cocoatomo/translation-friendly-message 
Make the log message more translation-friendly
 2018-02-07 02:27:51 +09:00
cocoatomo 1c61bf6db4 More translation-friendly messages 2018-02-07 02:12:22 +09:00
cocoatomo 8969ae40de Make the log message more translation-friendly 2018-02-07 01:52:22 +09:00
Takeshi KOMIYA 9c7c4c2034 Merge pull request #4562 from prakashdanish/patch-1 
potential typo
 2018-02-06 15:01:05 +09: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
Takeshi KOMIYA 7e5974f26c Merge pull request #4551 from tk0miya/dont_test_graphviz_on_travis 
Stop testings for graphviz on Travis CI
 2018-02-06 01:38:47 +09:00
Takeshi KOMIYA 3e0b5fb09d Merge pull request #4556 from tk0miya/4543_autodoc_test_fails_with_py353 
Fix #4543: test for autodoc fails with python 3.5.3
 2018-02-06 01:28:01 +09:00
Takeshi KOMIYA 9d33ec99b4 Deprecate: app.import_object() 2018-02-06 00:36:55 +09:00
Takeshi KOMIYA 3859136342 Refactor app._init_env() not to load env even if dump not found 2018-02-06 00:22:14 +09:00
Takeshi KOMIYA 51dfa73576 Fix #4543: test for autodoc fails with python 3.5.3 2018-02-05 14:38:35 +09:00
Takeshi KOMIYA e873129f30 Merge pull request #4552 from thijstriemstra/patch-2 
enable pip cache in appveyor build
 2018-02-05 11:24:13 +09:00
Thijs Triemstra cf7d97ce62 enable pip cache in appveyor build 2018-02-04 18:21:16 +01:00
Takeshi KOMIYA 1a35640974 Stop testings for graphviz on Travis CI 
To make our test faster, this stops testings for graphviz on Travis CI.
Instead of that, Circle CI confirms they are passed.
 2018-02-05 02:00:56 +09:00
Takeshi KOMIYA 69384902a4 Merge branch 'stable' into 1.7-release 2018-02-05 01:06:56 +09:00
Takeshi KOMIYA fa6d6ee5cc Fix version number 2018-02-05 01:06:18 +09:00
Takeshi KOMIYA 0b2b316be3 Bump version 2018-02-05 01:03:50 +09:00
Takeshi KOMIYA 645044d7f0 Bump to 1.6.7 final v1.6.7 2018-02-05 01:00:09 +09:00
Takeshi KOMIYA 5558b63315 Merge branch '1.7-release' 2018-02-04 23:24:38 +09:00
Takeshi KOMIYA 656e3be754 Fix #4539: autodoc emits warnings for partialmethods 2018-02-04 23:23:43 +09:00
Takeshi KOMIYA 18c0b23797 Merge branch 'stable' into 1.7-release 2018-02-04 23:20:48 +09:00