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
10,250 Commits 2 Branches 219 Tags 163 MiB
ff579b3c66
Commit Graph

10250 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
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
Stephen Finucane
4bc03706e8 doc: Rework "tutorial" document 
We're going to use this document as the basis for a future usage
document, so we start by cleaning things up beforehand. A couple of
changes are necessary:

- The installation guide is referenced, rather than duplicating the
  steps

In addition, there is 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-26 11:36:36 +00:00
Takeshi KOMIYA
6e89c7c906
Merge pull request #4671 from TimKam/4244-show-intersphinx-db 
Document: showing links & targets of Intersphinx mapping file
 2018-02-25 11:32:55 +09:00
Takeshi KOMIYA
82ee899d6e
Merge pull request #4673 from TimKam/4188-update-quickstart-doc 
#4188 update quickstart doc
 2018-02-25 11:32:08 +09:00
Takeshi KOMIYA
64c03f5bd4
Merge pull request #4631 from tk0miya/move_cmdline_to_cmd.build 
Move sphinx.cmdline to sphinx.cmd.build
 2018-02-25 01:46:19 +09: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
Takeshi KOMIYA
2dc539b393
Merge pull request #4620 from tk0miya/update_issue_template 
Proposal: Add a mention for sphinx-users group to ISSUE_TEMPLATE
 2018-02-24 02:20:40 +09:00
Takeshi KOMIYA
b2b500dda5 Merge branch 'master' into move_cmdline_to_cmd.build 2018-02-24 02:17:23 +09:00
Takeshi KOMIYA
a2bce15989 Merge branch '1.7' 2018-02-23 23:44:00 +09:00
Takeshi KOMIYA
a37f253a6b Bump version 2018-02-23 23:42:01 +09:00
Takeshi KOMIYA
d4b6839295 Bump to 1.7.1 final 2018-02-23 23:39:34 +09:00
Takeshi KOMIYA
e9520fe7c3
Merge pull request #4666 from tk0miya/4662_any_resolver_crashed 
Fix #4662: any refs with term targets crash when an ambiguity is encountered
 2018-02-23 23:28:05 +09:00
Takeshi KOMIYA
c41e746b7a Fix #4662: any refs with term targets crash when an ambiguity is encountered 2018-02-23 23:05:58 +09:00
Takeshi KOMIYA
6701676ddb
Merge pull request #4665 from tk0miya/4664_broken_intersphinx_cmdline 
Fix #4664: Reading objects.inv fails again
 2018-02-23 22:56:58 +09:00
Takeshi KOMIYA
cd08a6503c Fix #4664: Reading objects.inv fails again 2018-02-23 10:44:11 +09:00
Takeshi KOMIYA
4b0ff9a0d3 Update CHANGES for PR #4653 2018-02-23 00:45:18 +09:00
Takeshi KOMIYA
f4a527d8a6 Update CHANGES for PR #4653 2018-02-23 00:44:39 +09:00
Takeshi KOMIYA
7999aca606 Revert "Update CHANGES for PR #4653" 
This reverts commit 6f05c96027.
 2018-02-23 00:44:25 +09:00
Takeshi KOMIYA
6f05c96027 Update CHANGES for PR #4653 2018-02-23 00:13:17 +09:00
Takeshi KOMIYA
b192bbfb15
Merge pull request #4653 from adam-azarchs/patch-1 
Fix error reporting for parameterless ImportErrors
 2018-02-23 00:11:57 +09:00
Takeshi KOMIYA
16a7539007 Update CHANGES 2018-02-22 21:09:21 +09:00
Takeshi Suzuki
a34d39dd27 Fix incomplete localization strings in Polish (refs: #4655) 
Reflects the changes suggested in the comment below
https://github.com/sphinx-doc/sphinx/issues/4655#issuecomment-367310280
 2018-02-22 21:05:15 +09:00
Takeshi KOMIYA
6a699a38dd
Merge pull request #4663 from tockrock/4655_broken_translation 
Fix incomplete localization strings in Polish (refs: #4655)
 2018-02-22 21:04:21 +09:00
Takeshi KOMIYA
a46ba4f1a8
Merge pull request #4640 from tk0miya/4622_show_epub_scheme_only_for_epub3.1 
Show opt:scheme attribute only for EPUB3.1 (refs: #4622)
 2018-02-22 21:02:14 +09:00
Takeshi KOMIYA
cf36dd466c
Merge pull request #4605 from tk0miya/migrate_registry 
Migrate registry
 2018-02-22 20:57:00 +09:00
Takeshi KOMIYA
30cab5c376
Merge branch 'master' into migrate_registry 2018-02-22 20:21:09 +09:00
Takeshi KOMIYA
f6b1abf254
Merge pull request #4594 from tk0miya/4564_rst_prolog_not_working 
Change interface of add_source_parser() and add add_source_suffix()
 2018-02-22 20:19:13 +09:00
Takeshi KOMIYA
42a048ec27
Merge pull request #4661 from ederag/patch-1 
Typo: cocstring => docstring
 2018-02-22 17:12:52 +09:00
Takeshi Suzuki
138e84dfb9 Fix incomplete localization strings in Polish (refs: #4655) 
Reflects the changes suggested in the comment below
https://github.com/sphinx-doc/sphinx/issues/4655#issuecomment-367310280
 2018-02-22 14:37:32 +09:00
ederag
359050d88c
Typo: cocstring => docstring 2018-02-21 21:04:54 +01:00
Takeshi KOMIYA
5789b25847 Change interface of add_source_parser() and add add_source_suffix() 2018-02-21 10:54:49 +09:00
Takeshi KOMIYA
a0488dd884
Merge pull request #4659 from raybellwaves/master 
Update README.rst with get in touch section
 2018-02-21 09:50:42 +09:00
Ray Bell
24468eddbe
Update README.rst with get in touch section 2018-02-20 15:59:14 -05:00
adam-azarchs
6a2ec96c97 Fix error reporting for parameterless ImportErrors 
In some cases, a module may raise an ImportError without any arguments, e.g.

if not_allowed():
    raise ImportError

In this case, the exception has no args.  This is bad practice, but it happens.

Currently, autodoc will crash with

IndexError: tuple index out of range
 2018-02-20 12:22:47 -08:00
Takeshi KOMIYA
9c6d4f1308 Add simple wrapper to register nodes 2018-02-21 00:28:03 +09:00
Takeshi KOMIYA
8b8836b6d2 Show deprecation warning in directive_helper() 2018-02-21 00:27:18 +09:00
Takeshi KOMIYA
7fe27fdfc4
Merge pull request #4658 from tk0miya/4655_broken_translation 
Fix incomplete localization strings in Polish (refs: #4655)
 2018-02-21 00:07:23 +09:00
Takeshi KOMIYA
a5a11885c2
Merge pull request #4652 from tk0miya/fix_flake8_violations_in_master 
Fix flake8 violations
 2018-02-21 00:06:51 +09:00
Takeshi KOMIYA
b45c47757d Fix incomplete localization strings in Polish (refs: #4655) 2018-02-20 22:50:14 +09:00
Takeshi KOMIYA
8a2e498c2e
Merge pull request #4657 from tk0miya/update_codecov.yml 
Adjust .codecov.yml (again)
 2018-02-20 22:40:42 +09:00
Takeshi KOMIYA
93d1170769 Adjust .codecov.yml (again) 2018-02-20 20:51:53 +09:00
Jakob Lykke Andersen
bde93246c6 C++, parse 'this' in expressions. 2018-02-19 20:58:55 +01:00
Jakob Lykke Andersen
7d49a5311f C++, parse explicit casts and typeid in expression 2018-02-19 20:58:10 +01:00
Takeshi KOMIYA
56fe1d0414
Merge pull request #4644 from tk0miya/4641_toctree_glob_and_url 
Fix #4641: A external link in TOC cannot contain "?" with ``:glob:`` option
 2018-02-20 01:50:54 +09:00
Takeshi KOMIYA
446eab49b8 refactor: transplant node handlers for writer on instantiation of translator 
For now, node handlers are registered as class methods of translator
classes.  After this change, they are registered as instance method.
 2018-02-20 01:46:51 +09:00
Takeshi KOMIYA
18efa1a63a refactor: Store enumerable_nodes to registry 2018-02-20 01:32:30 +09:00
Takeshi KOMIYA
1ffa537b1c refactor: Store latex packages to registry 2018-02-20 00:19:32 +09:00