Commit Graph

10619 Commits

Author SHA1 Message Date
Takeshi KOMIYA
b6584090a8
Merge branch 'master' into refactor_env.update 2018-02-27 01:33:05 +09:00
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
645ad75523 Fix mypy violations 2018-02-26 02:21:26 +09:00
Takeshi KOMIYA
bc31485b10 Fix i18n: message catalogs were reset on each initialization 2018-02-25 23:44:38 +09:00
Takeshi KOMIYA
b3e7609a80 Update docs 2018-02-25 23:44:38 +09:00
Takeshi KOMIYA
2632a6d9a5 Fix error on serializing 2018-02-25 23:44:38 +09:00
Takeshi KOMIYA
ed403ad8ff Supports i18n console output 2018-02-25 23:44:37 +09:00
Takeshi KOMIYA
1c4a38c700 i18n: Support locale string having country code 2018-02-25 23:44:37 +09:00
Takeshi KOMIYA
cf62badce9 Add namespace feature to sphinx.locale 2018-02-25 23:44:37 +09:00
Takeshi KOMIYA
747a161cab refactor: Change translators to defaultdict 2018-02-25 23:44:37 +09:00
Takeshi KOMIYA
f5bc9fd5dd Add testcases 2018-02-25 23:44:37 +09: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
aba26657c5 Replace `l_() by _()` 2018-02-25 02:03:57 +09:00
Takeshi KOMIYA
8d653a406d Integrate `l_() into _()` 2018-02-25 02:03:57 +09:00
Takeshi KOMIYA
5b3e1dc856 Add locales.get_translation() to provide i18n feature for extensions 2018-02-25 02:03:40 +09:00
Takeshi KOMIYA
2a6596afe8 Use NullTranslation.add_fallback() to implement fallback
Updating _catalog attribute directly breaks a internal cache of
gettext module.
2018-02-25 02:03:40 +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
Takeshi KOMIYA
616e487941 Fix #4669: sphinx.build_main and sphinx.make_main throw NameError 2018-02-25 01:10:36 +09: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
d01d494119 Deprecate env.update()!
To make BuildEnvironment simple, the responsibility of converting
source files to doctrees is moved to Builder class.
2018-02-24 13:06:46 +09: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
4d4560e9be Separate env.update_config() from env.update() 2018-02-24 02:02:53 +09:00
Takeshi KOMIYA
9ff619330c Prepare env.settings data before read_doc()
The data on env.settings is not changed on each document.  So this
updates it before calling read_doc() to reduce the updates.
2018-02-24 00:26:44 +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