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
12,798 Commits 2 Branches 219 Tags 163 MiB
7c712464bb
Commit Graph

12798 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
175a7e6212 Update CHANGES for PR #5924 2019-02-11 12:43:39 +09:00
Takeshi KOMIYA
7f7d34def7
Merge pull request #5924 from arxanas/githubpages-cname 
githubpages: support custom domains
 2019-02-11 12:41:57 +09:00
Takeshi KOMIYA
3442d1b5b6
Merge pull request #6050 from tk0miya/6046_invalid_latex_elements 
Fix #6046: LaTeX: ``TypeError`` is raised when invalid latex_elements given
 2019-02-11 12:35:45 +09:00
Takeshi KOMIYA
ad517af81c
Merge branch 'master' into 5459_autodoc_default_options_accepts_True 2019-02-11 12:34:59 +09:00
Takeshi KOMIYA
11a398b1b0
Merge pull request #6052 from tk0miya/5394_meaningful_annotations_for_mock 
Display meaningful names in type annotations for mocked objects
 2019-02-11 12:32:45 +09:00
Waleed Khan
33c8b1d952 githubpages: support custom domains 
Github Pages allows you to link a custom domain to your Github Pages
site by adding a `CNAME` file at the top-level of your `docs` directory.
The `githubpages` extension already inserts a `.nojekyll` file in the
`docs` directory, so it's a good place to add support for this `CNAME`
file as well.
 2019-02-10 16:39:41 -08:00
Takeshi KOMIYA
8812131a57
Merge pull request #6022 from tk0miya/5196_linkcheck_should_check_remote_image 
Close #5196: linkcheck also checks remote images exist
 2019-02-11 02:05:14 +09:00
Takeshi KOMIYA
b0148c6921 Closes #5459: autodoc: autodoc_default_options accepts True as a value 2019-02-11 02:03:09 +09:00
Takeshi KOMIYA
0f6398efbb Close #5394: autodoc: Display readable names in type annotations for mocked objects 2019-02-11 01:48:21 +09:00
Takeshi KOMIYA
a6ef8190ce Add testcase for mocked objects in autodoc 2019-02-11 01:46:38 +09:00
Takeshi KOMIYA
453ed5e29a Merge branch 'master' into 5394_meaningful_annotations_for_mock 2019-02-11 01:38:26 +09:00
Takeshi KOMIYA
9ecf45e6ba Fix #6026: LaTeX: A cross reference to definition list does not work 2019-02-11 00:06:58 +09:00
Takeshi KOMIYA
3a237f7f4d
Merge pull request #6017 from tk0miya/4550_align_figures_to_center 
Close #4550: All tables and figures without ``align`` option are displayed to center
 2019-02-10 20:54:24 +09:00
Takeshi KOMIYA
7aaae7760a
Merge pull request #6023 from tk0miya/refactor_htmlhelp 
Refactor htmlhelp builder
 2019-02-10 20:50:10 +09:00
Takeshi KOMIYA
2f7e27810b Fix #6046: LaTeX: `TypeError` is raised when invalid latex_elements given 2019-02-10 19:47:41 +09:00
Stephen Finucane
b1ebdcd3c6 doc: Add "recipe" tutorial 
This is based on a post from opensource.com [1] and demonstrates how one
can use indexes for cross-referencing and domains to group these indexes
along with domains and roles. The source code was taken from [2] after
getting the license changed [3].

[1] https://opensource.com/article/18/11/building-custom-workflows-sphinx
[2] https://github.com/ofosos/sphinxrecipes
[3] https://github.com/ofosos/sphinxrecipes/issues/1

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2019-02-09 17:58:30 +00:00
Stephen Finucane
93081e2fce doc: Use 'literalinclude' directive for examples 
This avoid duplication and could conceivably let us test this stuff in
code later on.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2019-02-09 17:58:30 +00:00
Stephen Finucane
513d99c316 docs: Rework "todo" tutorial 
Adopt the same format as was recently added in the "hello world"
tutorial, making this more of a walkthrough as expected from tutorials.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2019-02-09 17:58:30 +00:00
Stephen Finucane
7bce985ac9 docs: Rework the "helloworld" tutorial 
Nothing to drastic going on here, but this format works better for other
tutorials we're adding.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2019-02-09 17:58:30 +00:00
Takeshi KOMIYA
dce1ccff67
Merge pull request #6045 from tk0miya/test_with_docutils-0.12 
Do test with docutils-0.12
 2019-02-09 16:09:10 +09:00
Takeshi KOMIYA
1a96f2b2cb Do test with docutils-0.12 2019-02-09 15:48:33 +09:00
Takeshi KOMIYA
3791013c08 quickstart: Simplify generated conf.py (master_doc) 2019-02-09 15:00:27 +09:00
Takeshi KOMIYA
d4df28c643 quickstart: Simplify generated conf.py (source_suffix) 2019-02-09 15:00:27 +09:00
Takeshi KOMIYA
d129f447c3 quickstart: Simplify generated conf.py (version and release) 2019-02-09 15:00:27 +09:00
Takeshi KOMIYA
d08903d9b9 quickstart: Simplify generated conf.py (EPUB) 2019-02-09 15:00:27 +09:00
Takeshi KOMIYA
319adefa9f epub: `epub_title defaults to the project` option 2019-02-09 15:00:27 +09:00
Takeshi KOMIYA
77b1d713a8 quickstart: Simplify generated conf.py (language) 2019-02-09 15:00:27 +09:00
Takeshi KOMIYA
7415f64eab refactor: htmlhelp: Generate .hhc file from template 2019-02-09 14:56:51 +09:00
Takeshi KOMIYA
28b0b744b6 refactor: htmlhelp: Generate .hhp file from template 2019-02-09 14:56:51 +09:00
Takeshi KOMIYA
264a4e8380 refactor: htmlhelp: Copy .stp file from template 2019-02-09 14:56:51 +09:00
Takeshi KOMIYA
91b6b46a7e
Merge pull request #6044 from tk0miya/refactor_test_docutils 
test: Give freshenv=True to test_docutilsconf for windows environment
 2019-02-09 14:55:47 +09:00
Takeshi KOMIYA
47058cd175 test: Give freshenv=True to test_docutilsconf for windows environment 2019-02-09 14:44:37 +09:00
Takeshi KOMIYA
a844ce0f2f
Merge pull request #6038 from tk0miya/refactor_test_docutilsconf 
refactor: test-docutilsconf
 2019-02-09 02:05:09 +09:00
Takeshi KOMIYA
1d5e3cba0e refactor: test-docutilsconf 
Use options for reST parser instead of HTML4 writer's.
 2019-02-09 00:49:49 +09:00
Takeshi KOMIYA
25027945f5 Close #4550: All tables and figures without `align` option are displayed to center 2019-02-08 01:39:41 +09:00
Takeshi KOMIYA
500bf85443
Merge branch 'master' into 5196_linkcheck_should_check_remote_image 2019-02-08 00:10:14 +09:00
Takeshi KOMIYA
5cca8407b5
Merge pull request #6031 from tk0miya/separate_dirhtml_package 
Move DirectoryHTMLBuilder to sphinx.builders.dirhtml package
 2019-02-07 23:39:37 +09:00
Takeshi KOMIYA
cf6d1eb820
Merge pull request #6030 from tk0miya/refactor_conftest 
refactor: tests/conftest.py
 2019-02-07 23:38:48 +09:00
Takeshi KOMIYA
55100dce26 refactor: tests/conftest.py 2019-02-07 22:14:06 +09:00
Takeshi KOMIYA
e24220d504
Merge pull request #6029 from tk0miya/clear_SPHINX_TEST_TEMPDIR_before_testing 
test: clear SPHINX_TEST_TEMPDIR before testing
 2019-02-07 13:43:28 +09: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
Vedran Miletić
6fa4c81058 Add more EXAMPLES 2019-02-06 21:23:20 +01:00
Takeshi KOMIYA
dd371a59de Move DirectoryHTMLBuilder to sphinx.builders.dirhtml package 2019-02-07 02:06:39 +09:00
Takeshi KOMIYA
9ac06520b9 test: clear SPHINX_TEST_TEMPDIR before testing 2019-02-07 01:28:45 +09:00
Takeshi KOMIYA
952d76dabb
Merge pull request #5996 from tk0miya/show_tempdir_header_on_testing 
Show tempdir header on testing (refs: #5902)
 2019-02-07 01:22:40 +09: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
Jean-François B
ed86ada661
Merge pull request #5992 from jfbu/latex_safe_graphics 
LaTeX: safer image inclusion
 2019-02-05 18:03:07 +01:00