Commit Graph

10637 Commits

Author SHA1 Message Date
Takeshi KOMIYA
cdd5503f5d Remove sphinx.ext.pngmath 2018-03-03 00:18:53 +09:00
Takeshi KOMIYA
c0a6795a0f
Merge pull request #4590 from stephenfin/doc-rework
Doc rework (user guide, part 2)
2018-03-02 01:59:51 +09:00
Takeshi KOMIYA
608695e851
Merge pull request #4695 from mitya57/pgen2
Remove the remaining traces of sphinx.pycode.pgen2 module
2018-03-02 01:21:58 +09:00
Takeshi KOMIYA
9ca956dda7
Merge pull request #4675 from tk0miya/deprecation_list
doc: Add deprecation list
2018-03-02 01:11:33 +09:00
Dmitry Shachnev
16d4e00043 Remove sphinx.pycode.pgen2 from flake8 exclude 2018-03-01 18:33:42 +03:00
Dmitry Shachnev
c5f243ef11 Remove LICENSE section for sphinx.pycode.pgen2 module 2018-03-01 18:33:42 +03:00
Dmitry Shachnev
28ad1c5847 Remove CompileGrammarCommand, it uses removed sphinx.pycode.pgen2 module 2018-03-01 18:33:42 +03:00
Takeshi KOMIYA
bd898be3fc doc: Add deprecation list
So far, deprecated APIs are only listed as CHANGES entry.  But
they are not listed in one place.  In this change, I gathered them
to docs as a list.
As a side effect, it makes CHANGES entry simple.
2018-03-02 00:01:49 +09:00
Takeshi KOMIYA
8dbc1b53d1
Merge pull request #4674 from tk0miya/improve_i18n
Improve i18n
2018-03-01 23:51:23 +09:00
Takeshi KOMIYA
278577c2ef
Merge branch 'master' into improve_i18n 2018-03-01 23:38:38 +09:00
Takeshi KOMIYA
c435bcf8dc Fix #4685: autosummary emits meaningless warnings 2018-03-01 22:29:50 +09:00
Takeshi KOMIYA
18bb86a27f Catch errors on compiling catalogs (refs: #4655) 2018-03-01 16:48:06 +09:00
Takeshi KOMIYA
4b8aaa2cf4 Fix infinit loop on make-mode 2018-03-01 01:12:47 +09:00
Takeshi KOMIYA
d48e1ef9e5 Merge branch '1.7' 2018-03-01 00:55:53 +09:00
Takeshi KOMIYA
7841de4a26 doc: Add a reference to awesome-sphinxdoc 2018-03-01 00:46:36 +09:00
Takeshi KOMIYA
6bce06757f Fix #4669: sphinx.build_main and sphinx.make_main throw NameError 2018-02-28 23:03:21 +09:00
Takeshi KOMIYA
9b4d90a494
Merge pull request #4672 from tk0miya/4669_broken_sphinx.build_main
Fix #4669: sphinx.build_main and sphinx.make_main throw NameError
2018-02-28 23:02:16 +09:00
Takeshi KOMIYA
7318983ccb
Merge pull request #4668 from tk0miya/refactor_env.update
Move env.update() to Builder class
2018-02-27 10:07:46 +09:00
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