Jakob Lykke Andersen
917fee7b94
Merge pull request #3945 from tony/patch-1
...
Doc: add label for C++ domain
2017-07-22 10:53:18 +02:00
Takeshi KOMIYA
618760cf58
Merge pull request #3948 from rneatherway/lgtm-fixes
...
Fix alerts found on lgtm.com
2017-07-21 14:18:40 +09:00
Takeshi KOMIYA
1055b68381
Merge pull request #3950 from tony/patch-2
...
Fix typo in TocTree warning
2017-07-21 10:58:59 +09:00
Tony Narlock
53ba31a6a5
Fix typo in TocTree warning
2017-07-19 06:36:02 -05:00
Robin Neatherway
3459de0aeb
Use with on file write to ensure closure
2017-07-19 09:59:24 +01:00
Robin Neatherway
3be324efb0
Remove impossible condition
...
We have just checked that `descname` is truthy, so it can't possibly
be falsy immediately afterwards.
2017-07-19 09:59:24 +01:00
Robin Neatherway
71e903635f
Remove redundant pass statement
2017-07-19 09:59:24 +01:00
Robin Neatherway
4ac0a8e278
Mark unused loop iteration variable as such
2017-07-19 09:59:24 +01:00
Robin Neatherway
63d68df1d1
Use NotImplementedError for better exception messages
...
NotImplemented would cause a TypeError
2017-07-19 09:59:24 +01:00
Robin Neatherway
4fb02e6900
Declare loop variables to make them local
2017-07-19 09:59:24 +01:00
Tony Narlock
112e8fe5e0
Add label for c++ domain
...
Currently it's [#id2](http://www.sphinx-doc.org/en/stable/domains.html#id2 ) on sphinx-doc documentation
2017-07-18 03:52:02 -05:00
Takeshi KOMIYA
947e01436b
Fix CHANGES (refs: #3869 )
2017-07-17 17:44:03 +09:00
Takeshi KOMIYA
ad00155894
Merge pull request #3869 from tk0miya/3866_suppress_pydomain_ref_warning
...
Fix #3866 : suppress pydomain ref warning
2017-07-17 17:43:09 +09:00
Takeshi KOMIYA
d65c5c4ed8
Merge branch 'master' into 3866_suppress_pydomain_ref_warning
2017-07-17 17:42:23 +09:00
Takeshi KOMIYA
5ce51728ba
Fix #3924 : docname lost after dynamically parsing RST in extension
2017-07-17 17:09:42 +09:00
Takeshi KOMIYA
9678cf715f
Merge pull request #3939 from vedranmiletic/documentation-fixes
...
Add more EXAMPLES, minor updates to existing ones
2017-07-17 14:11:42 +09:00
Vedran Miletić
6acf701e8a
Add more EXAMPLES, minor updates to existing ones
2017-07-16 19:41:52 +02:00
Timotheus Kampik
68fe4b2d6f
#3751 document -M command line option
2017-07-16 09:50:08 +02:00
Takeshi KOMIYA
246143dc3a
Merge pull request #3931 from tk0miya/3926_autodoc_warningiserror
...
Fix #3926 : Add ``autodoc_warningiserror`` to suppress the behavior of ``-W`` option
2017-07-16 14:06:38 +09:00
Takeshi KOMIYA
1e8421b8a1
Merge pull request #3932 from TimKam/1685-fix-docutils-markup-api-doc
...
#1685 remove non-existing attributes from custom directive doc
2017-07-16 11:51:17 +09:00
Takeshi KOMIYA
0f4262c391
Merge pull request #3933 from goodspark/py-rtype-xref
...
Python rtypes should match classes, not all objects
2017-07-16 11:50:19 +09:00
Sam Park
7020f6b41d
Add tests
2017-07-15 15:18:49 -07:00
Sam Park
5873c9644d
Python rtypes should match classes, not all objects
2017-07-15 14:33:52 -07:00
Timotheus Kampik
e8cfd0f3d4
#1685 remove non-existing attributes from custom directive doc
2017-07-15 21:49:35 +02:00
Takeshi KOMIYA
1869f4d674
Update docs (refs: #3923 )
2017-07-16 01:48:09 +09:00
Takeshi KOMIYA
d59fdda8c9
Merge pull request #3905 from TimKam/1236-add-note-referencing-arbitrary-locations
...
#1236 add note: omit underscore in internal ref
2017-07-15 22:37:51 +09:00
Takeshi KOMIYA
cb7d08ff68
Merge pull request #3918 from stephenfin/improved-man-pages
...
Improved man pages
2017-07-15 22:33:33 +09:00
Takeshi KOMIYA
26912026b0
Update CHANGES for PR #3927
2017-07-15 22:24:28 +09:00
Takeshi KOMIYA
58ad8646db
Merge pull request #3927 from rouge8/py-type-xref
...
Python parameter/variable types should match classes, not all objects
2017-07-15 22:22:58 +09:00
Takeshi KOMIYA
bfd71cd77b
Fix #3926 : Add `autodoc_warningiserror to suppress the behavior of -W` option
2017-07-15 22:04:56 +09:00
Takeshi KOMIYA
44caae0cc6
Merge pull request #3930 from vedranmiletic/documentation-fixes
...
Clean up and update EXAMPLES
2017-07-15 17:57:32 +09:00
Takeshi KOMIYA
e77b388f0b
Fix mypy violations
2017-07-15 17:48:19 +09:00
Takeshi KOMIYA
685eb4e3ec
Merge branch 'stable'
2017-07-15 16:59:18 +09:00
Takeshi KOMIYA
bb79a0c4d0
Fix mypy violations
2017-07-15 16:57:17 +09:00
Takeshi KOMIYA
e8c5589e23
Merge branch 'stable'
2017-07-15 16:47:42 +09:00
Takeshi KOMIYA
bcafa5772c
Fix flake8 violation
2017-07-15 16:47:32 +09:00
Takeshi KOMIYA
f349d18531
Merge branch 'stable'
2017-07-15 16:46:59 +09:00
Takeshi KOMIYA
fa77fe8ac9
Fix mypy violations (for mypy-0.520)
2017-07-15 16:44:53 +09:00
Vedran Miletić
38b39c008d
Clean up and update EXAMPLES
2017-07-14 18:25:22 +02:00
Andy Freeland
7046d17631
Python parameter/variable types should match classes, not all objects
...
Parameter and variable types in the Python domain have the
counter-intuitive behavior of matching instance methods (or likely any
other objects) rather than classes, e.g.:
```python
class Foo(object):
def list(self):
"""List some things."""
def bar(x):
"""
:param x: x
:type x: list
"""
```
`bar()` will link to `Foo.list()` rather than the standard library
`list` type.
2017-07-12 21:52:38 -07:00
Stephen Finucane
348bf2a421
doc: Remove 'Author' section from man pages
...
Per the closest thing we have to official man page guidelines [1]:
Use of an AUTHORS section is strongly discouraged. Generally, it is
better not to clutter every page with a list of (over time potentially
numerous) authors; if you write or significantly amend a page, add a
copyright notice as a comment in the source file.
We already do a good job of tracking authors in the AUTHORS file, so we
can remove this.
[1] https://linux.die.net/man/7/man-pages
Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-07-11 16:08:49 +01:00
Stephen Finucane
65a81e2056
doc: Add sphinx-autogen man page
...
This wasn't documented in depth anywhere, so do just that.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-07-11 16:08:40 +01:00
Stephen Finucane
9b7525d47d
doc: Remove 'invocation' document
...
This contains no useful information at this point. Better to simply drop
it.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-07-11 16:08:33 +01:00
Stephen Finucane
12e190f35f
doc: Update sphinx-build man page
...
This man page wasn't making full use of Sphinx's own features. Update it
to do so, and remove the duplicated information from 'invocation'.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-07-11 16:08:29 +01:00
Stephen Finucane
2cfa2bc673
doc: Update sphinx-quickstart man page
...
This man page wasn't making full use of Sphinx's own features. Update it
to do so, and remove the duplicated information from 'invocation'.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-07-11 16:07:36 +01:00
Stephen Finucane
c244a7c9a9
doc: Update sphinx-apidoc man page
...
This man page wasn't making full use of Sphinx's own features. Update it
to do so, and remove the duplicated information from 'invocation'.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-07-11 15:59:32 +01:00
Stephen Finucane
75154196b1
.gitignore: Ignore '.venv' directories
...
This is a commonly used name for virtualenv directories and should be
ignored.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-07-10 14:17:59 +01:00
Timotheus Kampik
328e57949e
#1236 add note: omit underscore in internal ref
2017-07-02 15:19:47 +02:00
Takeshi KOMIYA
662d8deaf7
Merge pull request #3904 from TimKam/2307-fix-markup-glitch-lineno-start-doc
...
#2307 add `::` to show markup sample, not evaluate it
2017-07-02 21:54:31 +09:00
Takeshi KOMIYA
4a5ee3921b
Remove sphinx.util.compat again (rebirthed on merging)
2017-07-02 21:51:33 +09:00
