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,565 Commits 2 Branches 219 Tags 163 MiB
17596b5f3c
Commit Graph

12565 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Stephen Finucane
17596b5f3c docs: Remove unused imports 
These were causing flake8 failures.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2019-02-25 11:03:59 +00:00
Stephen Finucane
a35040c454 docs: Address further review comments 
todo:
- Subclass SphinxDirective instead of Directive

recipe:
- Remove unnecessary '__init__' methods

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2019-02-18 13:46:30 +00:00
Stephen Finucane
5c061ff266 docs: Address review comments 
helloworld:
- Return version metadata from extension
- Use 'reST' instead of 'rST'
- Don't use single backticks

todo:
- Return version metadata from extension
- Link to events section of API guide, rather than entire document
- Include name of phases in when describing build phases
- Use more method cross-references where possible
- Fix typo in usage example

recipe:
- Return version metadata from extension
- Rework code to simplify things
- Remove docstrings from 'generate' functions, which are simply
  duplicates of the original docstring
- Rename 'rcp' directive to 'recipe', the 'reref' role to 'ref', and a
  whole lot of variables to something more grokable
- Fix typos in both documentation and code

I've also fixed up the docstrings for some of the 'domain' functions to
make them render a little nicer (they took me a while to figure out).

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2019-02-14 10:31:45 +00: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
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
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
jfbu
87058e6783 Remove from test never executed print(result) debugging info 2019-02-05 17:51:13 +01:00
jfbu
0d72052141 Merge branch 'master' into latex_safe_graphics 2019-02-05 17:46:00 +01:00
Takeshi KOMIYA
ab544a9818
Merge pull request #6024 from tk0miya/refactor_test_build_html 
refactor: test_build_html.py
 2019-02-06 01:21:37 +09:00
Takeshi KOMIYA
ff80d2f538
Merge pull request #5983 from tk0miya/separate_applehelp 
Separate applehelp to sphinxcontrib package
 2019-02-06 01:14:02 +09:00
Takeshi KOMIYA
08ad2c8143 refactor: test_build_html.py 2019-02-06 00:53:44 +09:00
Takeshi KOMIYA
c4397318d3 Separate applehelp to sphinxcontrib package 2019-02-06 00:44:37 +09:00
Takeshi KOMIYA
20edbe9500
Merge pull request #6015 from tk0miya/1851_omit_argument_for_code-block 
Close #1851: Allow to omit an argument for code-block directive
 2019-02-06 00:24:17 +09: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
jfbu
3e0c65a245 Merge branch '1.8' 2019-02-04 12:52:52 +01:00
Jean-François B
b68d1d1066
Merge pull request #6005 from jfbu/latex_space_after_author 
LaTeX: remove extra space after author on title page in PDF
 2019-02-04 12:23:14 +01:00
Takeshi KOMIYA
eef5a4a954
Merge pull request #5980 from tk0miya/doc_get_translation 
doc: Update docstring of get_translation()
 2019-02-04 02:00:10 +09:00
Takeshi KOMIYA
3fbb599d23
Merge pull request #5985 from tk0miya/refactor_test_build_html 
refactor: test_build_html.py
 2019-02-04 01:59:21 +09:00
Takeshi KOMIYA
d1cd72660b
Merge pull request #6012 from tk0miya/update_svgimg 
Fix test: imgconverter expects size of images fixed
 2019-02-04 01:53:34 +09:00
Takeshi KOMIYA
2e910d50f3
Merge pull request #6013 from tk0miya/update_manpage 
doc: Remove --epub option from man page for sphinx-build
 2019-02-04 01:53:21 +09:00
Takeshi KOMIYA
6ca669295c Close #1851: Allow to omit an argument for code-block directive 2019-02-04 01:50:44 +09:00
Takeshi KOMIYA
6fd191d52e
Merge pull request #6014 from tk0miya/fix_indentation 
doc: Fix indentation
 2019-02-04 01:41:19 +09:00
Takeshi KOMIYA
e0e3ba4d91 doc: Fix indentation 2019-02-04 01:31:30 +09:00
jfbu
decca71ef7 LaTeX: remove extra space after author on title page in PDF 
Closes: #6004

Comment: \begin{tabular}[@{}c@{}] does not work in case of multiple
authors separated by \and in latex_documents, because latex has this
definition of \and :

macro:->\end {tabular}\hskip 1em \@plus .17fil\begin {tabular}[t]{c}

which means we would need to modify it to read

macro:->\end {tabular}\hskip 1em \@plus .17fil\begin {tabular}[t]{@{}c@{}}

(or only one @{} at end) modifying space between two authors.
 2019-02-03 17:07:26 +01:00
Takeshi KOMIYA
e02526b056 doc: Remove --epub option from man page for sphinx-build 2019-02-04 00:29:53 +09:00
Takeshi KOMIYA
07f3f034a8
Merge pull request #6011 from tk0miya/fix_compile_latex_document 
Fix test: compile_latex_document()
 2019-02-04 00:05:33 +09:00
Takeshi KOMIYA
21fef75c3b Fix test: imgconverter expects size of images fixed 2019-02-03 23:59:15 +09:00
Takeshi KOMIYA
7b1755d21b Fix test: compile_latex_document() 2019-02-03 23:54:22 +09:00
Takeshi KOMIYA
622a678377
Merge pull request #6010 from tk0miya/4611_show_warnings_for_duplicated_toctree 
Fix #4611: epub: Show warning for duplicated ToC entries
 2019-02-03 23:36:43 +09:00