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
8,987 Commits 2 Branches 219 Tags 163 MiB
d59fdda8c9
Commit Graph

8987 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
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
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
Takeshi KOMIYA
007593fa81 Merge branch 'stable' 2017-07-02 20:28:50 +09:00
Timotheus Kampik
16a2367301 #2307 add :: to show markup sample, not evaluate it 2017-07-02 13:24:38 +02:00
Takeshi KOMIYA
7a8384c81f Bump version 2017-07-02 20:18:52 +09:00
Takeshi KOMIYA
ddeccfc2c7 Bump to 1.6.3 final 2017-07-02 20:15:05 +09:00
Takeshi KOMIYA
4791c35edf Fix #3902: Emit error if `latex_documents` contains non-unicode string in py2 2017-07-02 20:00:21 +09:00
Takeshi KOMIYA
dc6a8a5457 test: Fix autosummary testcase 2017-07-02 18:41:03 +09:00
Takeshi KOMIYA
b3e0e29f4c Fix #3900: autosummary could not find methods 2017-07-02 18:26:41 +09:00
Takeshi KOMIYA
82adedbc56 Update CHANGES for PR #3876 2017-07-02 17:08:27 +09:00
Takeshi KOMIYA
1b67a8eb9d Merge pull request #3876 from jfbu/fixboxdrawing 
Fix #3851 and fix #3706 about box drawing characters for PDF output
 2017-07-02 17:07:05 +09:00
Takeshi KOMIYA
1f8604e481 Fix :manpage: role is smarty-quoted (refs: #3286) 2017-07-01 18:20:05 +09:00
Takeshi KOMIYA
4225279992 Merge pull request #3875 from tk0miya/3824_no_smart_quotes_for_nodes 
3824 no smart quotes for nodes
 2017-07-01 17:29:09 +09:00
Takeshi KOMIYA
04f5af982d Merge pull request #3890 from tk0miya/3860_errors_caused_by_remote_images 
3860 errors caused by remote images
 2017-07-01 17:21:30 +09:00
Takeshi KOMIYA
63cf97228f Merge branch 'stable' into 3860_errors_caused_by_remote_images 2017-07-01 17:21:21 +09:00
Takeshi KOMIYA
e992049a23 Merge pull request #3889 from tk0miya/3833_dont_translate_commandline_messages 
Fix #3833: command line messages are translated unintentionally
 2017-07-01 17:18:31 +09:00
Takeshi KOMIYA
a0f3cced09 Merge branch 'stable' into 3833_dont_translate_commandline_messages 2017-07-01 17:18:21 +09:00
Yoshiki Shibukawa
efb310f8f0 Merge pull request #3899 from sphinx-doc/fix/issue-3840 
fix #3840: epub_uid should be XML Name
 2017-07-01 00:12:01 +09:00
Yoshiki Shibukawa
f0766ce4cd fix #3840: epub_uid should be XML Name 2017-06-30 23:37:32 +09:00
Takeshi KOMIYA
2d5e05a2ee Update CHANGES for PR #3893 2017-06-26 23:52:02 +09:00
Takeshi KOMIYA
2e7cc4c2a1 Merge pull request #3893 from useblocks/master 
Unknown html_theme_options throw warnings instead of errors.
 2017-06-26 23:50:52 +09:00
daniel
aecb008213 Changed test case "test_theme_api" to check, if a not needed html_theme_option is not part of the returned, final configuration of theme.get_options(). 
PR #3893
 2017-06-26 09:18:46 +02:00
daniel
4ce6da9c96 Unknow html_theme_options throw warnings instead of errors. 
New behavior: a sphinx build does not stop, if for the configured theme an unknown but also unneeded html_theme_options is provided.

Fixed #3884
 2017-06-26 08:58:45 +02:00
Takeshi KOMIYA
1d0f667ecd Update warning message (ref: #3873) 2017-06-25 23:03:23 +09:00
Takeshi KOMIYA
959d0b92c9 Show correct URI if image candidate not found 2017-06-25 19:02:30 +09:00
Takeshi KOMIYA
372e8f2c64 Add simple svg tester for imghdr 2017-06-25 19:02:29 +09:00
Takeshi KOMIYA
957c132c23 Remove sphinx.util.compat again (rebirthed on merging) 2017-06-25 18:57:22 +09:00
Takeshi KOMIYA
ea87cfba4f Fix #3860: Remote image URIs without filename break builders not supported remote images 2017-06-25 18:49:13 +09:00