Takeshi KOMIYA
350f5b3600
Merge pull request #7751 from stephenfin/doc/intro-section
...
[doc] Remove the intro guide in favour of the quickstart guide
2020-05-31 01:12:35 +09:00
Stephen Finucane
97d1b323b7
docs: Merge intro and quickstart guide
...
The intro guide mostly contained out-of-date information or information
that was duplicated from elsewhere. Remove it in favour of an enhanced
quickstart guide.
Signed-off-by: Stephen Finucane <stephen@that.guru >
2020-05-30 15:25:45 +01:00
Stephen Finucane
f07ad49c22
docs: Add usage, development index page
...
Signed-off-by: Stephen Finucane <stephen@that.guru >
2020-05-30 15:24:40 +01:00
Stephen Finucane
ceb72f9cd7
doc: Rework "latex" document
...
Remove some unnecessary indentation, consistently document option
defaults, and fix some wrapping and whitespace.
Signed-off-by: Stephen Finucane <stephen@that.guru >
2020-05-30 15:23:36 +01:00
Takeshi KOMIYA
800dcf0f0a
Close #2106 : autodoc: Support multiple signatures on docstring
2020-05-30 15:40:21 +09:00
Kai Welke
0ee57a6f6e
Fixed broken link to pygments lexers doc
2020-05-26 09:35:47 +02:00
Michaël Defferrard
5e5bd748e6
remove repeted word in reStructuredText Primer
2020-05-20 22:30:58 +02:00
Takeshi KOMIYA
752d3285d2
Update docs (refs: #7469 )
2020-05-21 00:56:32 +09:00
Daniel Fremont
de4aca857c
revisions per comments from tk0miya
2020-05-17 09:07:11 -07:00
Daniel Fremont
f9e9bdc4a0
Merge remote-tracking branch 'sphinx/3.x' into 3.x
2020-05-17 08:09:45 -07:00
Takeshi KOMIYA
3c7d35d2a2
Merge branch '3.x'
2020-05-17 19:12:56 +09:00
Takeshi KOMIYA
b1554ae25a
doc: Fix wrong version info
2020-05-10 01:12:39 +09:00
Takeshi KOMIYA
e5dad73cf2
py domain: Add :canonical: option
2020-05-04 14:49:50 +09:00
Takeshi KOMIYA
f82151bda5
Merge branch '3.x'
2020-05-02 10:43:10 +09:00
Takeshi KOMIYA
71eddf3095
Merge branch '3.x'
2020-04-30 21:49:28 +09:00
Takeshi KOMIYA
155cb87452
doc: Fix examples of doctest extensions are still in py2 (refs: #7575 )
2020-04-29 22:46:44 +09:00
Takeshi KOMIYA
aa773cbc88
Merge branch '3.x'
2020-04-28 01:42:37 +09:00
Takeshi KOMIYA
87308d9607
Close #7143 : py domain: Add :final: option to py:*: directives
2020-04-28 01:24:29 +09:00
Takeshi KOMIYA
42aa293679
Merge branch '3.x'
2020-04-27 00:54:23 +09:00
Takeshi KOMIYA
037fe96dc1
Close #4030 : autosummary: Add autosummary_context
2020-04-25 11:15:43 +09:00
Takeshi KOMIYA
c9e4945623
Merge pull request #7473 from eric-wieser/meta-public
...
Add support for :meta public:
2020-04-23 02:15:42 +09:00
Takeshi KOMIYA
6e28675727
doc: Fix version
2020-04-21 23:38:18 +09:00
Takeshi KOMIYA
7671bcc23b
Remove autosummary_recursive configuration
...
Now autosummary directive has :recursive: option to enable the
recursive feature individually. So the configuration is no longer
needed.
2020-04-21 23:38:18 +09:00
Takeshi KOMIYA
b9da9237bc
Merge branch '3.x' into 6040_autosummary_recursive
2020-04-21 23:04:38 +09:00
Takeshi KOMIYA
476b73b6ca
autosummary: Add :recursive: option to autosummary directive
2020-04-21 22:47:00 +09:00
Takeshi KOMIYA
c2c95ef587
Merge pull request #7411 from tk0miya/latex_theme_options
...
LaTeX: Add `latex_theme_options` to override theme options
2020-04-20 01:50:06 +09:00
Takeshi KOMIYA
12cb90c3fa
Merge pull request #7492 from tk0miya/7490_autosummary_caption
...
Close #7490 : autosummary: Add ``:caption:`` option to autosummary directive
2020-04-20 00:52:45 +09:00
Takeshi KOMIYA
05aff200b1
LaTeX: Add :confval:latex_theme_options to override theme options
2020-04-20 00:51:08 +09:00
Takeshi KOMIYA
68375c92f2
Fix #7488 : Update docs
2020-04-19 23:01:57 +09:00
Takeshi KOMIYA
adad0e62bb
Merge branch '3.x'
2020-04-18 21:54:31 +09:00
Takeshi KOMIYA
1e3ce31b03
Merge pull request #7443 from mgeier/theme-options-toctree
...
Add globaltoc_collapse and globaltoc_includehidden options
2020-04-16 23:11:28 +09:00
Takeshi KOMIYA
dc46897768
Close #7490 : autosummary: Add `:caption:` option to autosummary directive
2020-04-16 23:04:57 +09:00
Matthias Geier
3baa6e09e2
FIXUP: move "versionadded"
2020-04-15 21:02:41 +02:00
Takeshi KOMIYA
19d5d8d75c
Fix #7477 : imgconverter: Invoke "magick convert" command on Windows
2020-04-15 23:23:28 +09:00
Eric Wieser
0d7451c23d
Add support for :meta public:
...
A common use case for this is a class like `namedtuple`, which has a public `_replace` method that is so-named in order not to conflict with arbitrary user-provided attributes.
Rejected spellings include:
* `:meta not-private:`
* `:meta private: False`
2020-04-14 08:41:45 +01:00
Matthias Geier
c17f00c7a2
DOC: globaltoc_collapse, globaltoc_includehidden
2020-04-13 19:22:17 +02:00
Takeshi KOMIYA
1aca70cf80
Merge branch '3.x'
2020-04-13 23:36:49 +09:00
Takeshi KOMIYA
b2a601a33d
Merge branch '3.0.x' into 3.x
2020-04-13 23:36:10 +09:00
Jakob Lykke Andersen
09f66c690b
Merge pull request #7468 from jakobandersen/c_namespace
...
C, add scoping directives
2020-04-13 13:47:39 +02:00
Jakob Lykke Andersen
d4058eb67f
C, parse attributes
2020-04-13 13:43:26 +02:00
Daniel Fremont
8ee7d908f3
updated corresponding documentation
2020-04-12 12:06:14 -07:00
Jakob Lykke Andersen
bbc7b6cc54
C, add scoping directives
2020-04-12 14:13:54 +02:00
Tetsuo Koyama
4983a12f21
➕ 🇧🇬 🇮🇳 🇦🇱 🇷🇸
2020-04-12 19:04:42 +09:00
Takeshi KOMIYA
10d7760156
Fix #7410 : Allow to suppress "circular toctree references detected" warnings
2020-04-12 15:25:35 +09:00
Rick Wertenbroek
df1b05a659
Update Instalation.rst - Docker sphinx-quickstart
...
I suggest adding the -it option to the docker run command for sphinx-quickstart since it is an interactive command.
Without interaction, the process will simply stop with the [Interrupted.] state after the first option
...
> Separate source and build directories (y/n) [n]:
[Interrupted.]
2020-03-25 11:18:18 +01:00
Takeshi KOMIYA
90fb44ee43
Merge branch '3.x'
2020-03-23 00:07:51 +09:00
Takeshi KOMIYA
ab75982be0
Fix document
2020-03-22 17:49:17 +09:00
Takeshi KOMIYA
8806cc257a
Merge pull request #7348 from tk0miya/7340_toctree_doc
...
doc: Update about toctree directive
2020-03-22 16:28:36 +09:00
Takeshi KOMIYA
c7e590818a
Merge branch '3.x'
2020-03-21 17:53:22 +09:00
Takeshi KOMIYA
eccb9abe4a
doc: Update about toctree directive
2020-03-21 16:37:34 +09:00
