IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-08-11 05:24:49 -05:00
Code Issues Packages Projects Releases Wiki Activity
20,141 Commits 11 Branches 236 Tags
12e7cff0b695dbc6974fc3a438439a2a86f2a258
Commit Graph
81 Commits
Author SHA1 Message Date
Adam Turner de3aa8a318 Replace non-functional Bitbucket URLs 
- ``sphinx-contrib`` has moved to GitHub
- Replace personal project links with links to the Bitbucket archive
 2023-07-14 06:52:25 +01:00
TLoufAdam TurnerJean-François BTLouf
 		86b07d4a97 Allow multi-line object description signatures (#11011) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Co-authored-by: Jean-François B <2589111+jfbu@users.noreply.github.com>
Co-authored-by: TLouf <loufthomas@gmail.com>
 2023-05-11 14:28:57 +01:00
Adam Turner 7ecf037280 Enable 'nit-picky mode' for Sphinx's documentation 
Fix several reference errors throughout the documentation and set
``nitpick_ignore`` in ``doc/conf.py``.
 2023-04-06 23:11:39 +01:00
Adam Turner e70a0fac6d Merge branch '5.x' 
# Conflicts:
#	.github/workflows/main.yml
#	CHANGES
#	sphinx/__init__.py
#	sphinx/domains/c.py
 2022-10-16 11:24:18 +01:00
Martin LiškaandAdam Turner 0a91adb64d Extend cross referencing options with values (#10883) 
This change means that text following `=`, `[=`, or ` ` is ignored when
searching for a corresponding option directive to an option cross reference
role. These are commonly used options, for example `--profile=path`, 
`--profile[=path]` or `--profile path`.

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-10-02 15:50:53 +01:00
Adam Turner 63dea6172a Merge branch '5.x' 
# Conflicts:
#	sphinx/locale/__init__.py
 2022-09-30 16:15:24 +01:00
Adam Turner 2906071198 Merge branch '5.2.x' into 5.x 
# Conflicts:
#	CHANGES
#	sphinx/__init__.py
 2022-09-30 16:13:11 +01:00
Adam Turner 650f63b9f7 Finer grained control over domain ToC entries (#10886) 
- Implement `:nocontentsentry:` flag
- Use `:nocontentsentry:` in docs
- Add domain object table of contents configuration option
 2022-09-30 10:31:58 +01:00
Martin Liska 29e6adab12 extend option directive syntax 
One can cross-reference an option value: :option:`--module=foobar`.
 2022-09-27 19:02:45 +01:00
Adam Turner 56aa3412ef Merge branch '5.x' 
# Conflicts:
#	setup.py
#	sphinx/__init__.py
 2022-09-23 17:27:00 +01:00
Adam Turner f57177de89 Add contents entries for domain objects (#10807) 
- Add entries in the table of contents for domain objects (e.g. 
  `py:function`, `rst:role`, etc). Supported domains are Javascript,
  Python, and reStructuredText.
- Support content in `py:module` and `js:module` directives.
- Add the `noindexentry` and `noindex` flags to more domains.
- Add `toc_object_entries_show_parents` configuration setting
- Update documentation and tests
 2022-09-13 20:20:02 +01:00
Adam Turner ee005caf22 Do not apply epigraph style to all block quotes 
Correct indentation where appropriate for stanzas that should not be
rendered as `<blockquote>` HTML elements.

Closes GH-10686
 2022-09-12 19:54:36 +01:00
Jean-François B 80198e82aa Merge branch '5.x' into master 
Resolved merge conflicts:
    sphinx/ext/extlinks.py
    sphinx/ext/napoleon/docstring.py
    (and removed from the latter a now unused import for flake8 F401
    compliance)
 2022-06-30 15:00:16 +02:00
Adam Turner ac0fc4b781 Remove more deprecated items in Sphinx 6.0 (#10562) 2022-06-26 15:01:09 +01:00
jfbu 8ecbe8a15a Improve mark-up in docs (follow-up to PR #10366) 2022-06-26 09:30:22 +02:00
Martin LiškaandAdam Turner f789148fa2 Allow emphasising placeholders in option directives (#10366) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-06-16 20:46:01 +01:00
Takeshi KOMIYA 08f5d97a82 Fix #10223: doc: Add descriptions of :module: option for python directives 2022-03-06 16:10:40 +09:00
Takeshi KOMIYA 481c5e9c4b Merge pull request #9534 from astrojuanlu/new-tutorial-describing-code 
New Sphinx tutorial, part III
 2021-10-09 13:05:48 +09:00
Jakob Lykke Andersen a6246c1b65 Typo fixes 2021-10-01 20:48:12 +02:00
Jakob Lykke Andersen 91d0289009 C++, add retval info field to cpp:function 2021-10-01 20:47:14 +02:00
Jakob Lykke Andersen 57fad5c044 C, update documentation for info-fields 2021-10-01 18:38:30 +02:00
Juan Luis Cano Rodríguez 2c1fa831c1 Add tutorial section on documenting Python objects 2021-08-12 20:06:56 +02:00
Takeshi KOMIYA 120525563c Cloase #9445: :py:property: directive now supports :classmethod: option 
Since python 3.9, `classmethod` starts to support creating a "class
property".  This allows to describe it.
 2021-07-17 14:24:31 +09:00
Eisuke Kawashima 652ebf1bf5 Fix typo 2021-07-08 08:16:22 +09:00
ocket8888 9db8775ba7 Update example to use recommended usage 2021-06-14 11:21:28 -06:00
Takeshi KOMIYA d8fa067583 Add doc and testcase for program directive (refs: #9137) 
There is no docs and testcases for "None" argument of the program
directive.  It has been implemented since very old version.  But it's
not documented and tested long.
 2021-04-28 02:16:57 +09:00
Takeshi KOMIYA 41a377fee5 Merge branch '3.x' 2021-04-04 00:06:45 +09:00
Albert Villanova del Moral 260725c823 Fix minor typo 2021-03-30 08:45:34 +02:00
Takeshi KOMIYA 204f86f736 py domain: Add py:property directive to describe a property (refs: #7068) 2021-03-11 01:56:39 +09:00
jfbu 62401ef1ec Merge branch '3.x' 2021-02-12 21:27:17 +01:00
Jakob Lykke Andersen a7fcc15683 C++, add noroot option to alias directive 2021-02-12 17:25:12 +01:00
Jakob Lykke Andersen 06a956200b C, add noroot option to alias directive 2021-02-12 17:25:12 +01:00
Jakob Lykke Andersen d0a4d0147e C++, add recursiveness to alias 
Fixes sphinx-doc/sphinx#8213 in the most basic way.
 2021-02-12 17:25:12 +01:00
Takeshi KOMIYA 26ea870267 Merge branch '3.x' into master 2020-10-03 13:43:21 +09:00
Steve Piercy 81d7f2ee8a Update link to sphinxcontrib on GitHub 2020-09-26 16:32:59 -07:00
Jakob Lykke Andersen 500f45fd4c C, recursive alias declarations 
Fixes sphinx-doc/sphinx#8141
 2020-09-13 16:37:53 +02:00
Takeshi KOMIYA 1a223209f2 Merge branch '3.x' 2020-07-05 19:56:21 +09:00
Jakob Lykke Andersen c668500a4b Add :noindexentry: option 
Fixes sphinx-doc/sphinx#7052
 2020-07-04 19:34:00 +02:00
Takeshi KOMIYA ec3754bd94 Merge branch '3.x' 2020-07-05 01:32:54 +09:00
Jakob Lykke Andersen 8c82ecbf2c Merge pull request #7895 from jakobandersen/c_cpp_noindex 
C, C++: remove noindex option
 2020-07-02 15:38:45 +02:00
Jakob Lykke Andersen ff5eb7cc2b C, C++: remove noindex option 
The option did nothing.
Improve error messages on duplicates.
 2020-06-30 13:52:18 +02:00
Jakob Lykke Andersen 7cbf54c210 C, add c:alias directive 2020-06-30 11:20:17 +02:00
Takeshi KOMIYA e5dad73cf2 py domain: Add :canonical: option 2020-05-04 14:49:50 +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 b2a601a33d Merge branch '3.0.x' into 3.x 2020-04-13 23:36:10 +09:00
Jakob Lykke Andersen d4058eb67f C, parse attributes 2020-04-13 13:43:26 +02:00
Jakob Lykke Andersen bbc7b6cc54 C, add scoping directives 2020-04-12 14:13:54 +02:00
Jakob Lykke Andersen b2ca906830 C, add expression parsing and expr role 2020-03-15 19:49:16 +01:00
Jakob Lykke Andersen 815a9c657d C, add new directives, fix xref lookup 2020-03-15 19:49:16 +01:00
Jakob Lykke Andersen 0f49e30c51 C, initial rewrite 2020-03-15 19:49:16 +01:00