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
21,214 Commits 2 Branches 219 Tags 163 MiB
fadb6b10cb
Commit Graph

49 Commits

Author SHA1 Message Date
Adam Turner
9e3f4521db
Drop support for Python 3.9 (#12633) 2024-07-22 15:05:15 +01:00
Tim Hoffmann
a53a758d40
DOC: Rewrite installation instructions (#12458) 
- Put pip and conda as the most common options first
- Don't distinguish Linux / Windows in the pip commands.
- Replace the venv instructions by a general tip to use environments and link out for details.
- Collect all OS-specific package manager in one section
- Remove the "Windows - Other methods" secion. 
- Move latest development release to a separate entry. 

Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>
 2024-06-25 12:17:55 +02:00
Bénédikt Tran
f44ff30673
[doc] cleanup references and update external URLs (#12182) 2024-03-25 11:39:05 +01:00
Adam Turner
ad61e41157
Drop support for Python 3.8 (#11511) 2023-07-25 02:07:23 +01:00
Adam Turner
4660b62de0 Drop Python 3.7 2022-09-27 18:31:47 +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
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
Adam Turner
7e38d2dad8 Merge branch '5.x' 
# Conflicts:
#	.github/workflows/builddoc.yml
#	.github/workflows/lint.yml
#	sphinx/registry.py
 2022-06-16 21:46:54 +01:00
Takeshi KOMIYA
7e68154e49
Drop python 3.6 support (#10468) 2022-06-16 19:33:55 +01:00
Julien Palard
956cddb7d4
Replace doclinter with sphinx-lint (#10389) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-06-16 19:32:09 +01:00
Takeshi KOMIYA
5dc27f5948 Merge branch '4.x' 2021-12-17 02:09:33 +09:00
Takeshi KOMIYA
dd27e35e4c doc: Use "console" for the highlight language of console output 
Using "console" language is better for the console example (including
command-line prompt)
 2021-12-13 14:20:37 +09:00
Agbonze Osazuwa
6f4280c0a3
Fixes statement typo 2021-12-04 13:13:17 +01:00
Jens Haase
dca21ceab4
Fixed docker links in the installation.rst 
The old links, linked to a login page of docker hub. The new links link to the public pages.
 2021-11-01 13:31:47 +01:00
Drew Mares
5b4b95790a
Update Chocolatey Install Link 
The install URL returned a 404 but now it is updated to the new location
 2021-10-27 11:39:40 -05:00
John Cole
8dbef8798a Fix typo 2021-08-04 20:28:45 -04:00
Juan Luis Cano Rodríguez
1ffbfa72f1 Merge branch '4.x' into new-tutorial 2021-06-06 10:49:07 +02:00
Takeshi KOMIYA
e0500f7354 doc: Fix docslint misunderstanding scope of code-blocks 2021-06-06 13:24:06 +09:00
Juan Luis Cano Rodríguez
565713d228 Change Pygments lexer to account for prompt 2021-05-31 18:03:04 +02:00
Juan Luis Cano Rodríguez
1da5ab5808 Style fixes 
Co-authored-by: Steve Piercy <web@stevepiercy.com>
 2021-05-31 16:26:21 +02:00
Juan Luis Cano Rodríguez
bfca913f16 Move virtual environment explanation to installation 2021-05-29 19:15:15 +02:00
Takeshi KOMIYA
ae413e95ed
Merge pull request #8970 from naveen521kk/patch-1 
Sphinx is available on Chocolatey
 2021-03-07 21:30:46 +09:00
Naveen M K
1b425230e3
lint 2021-03-07 00:21:41 +05:30
Naveen M K
2638e9aecc
Sphinx is available on Chocolatey 2021-03-07 00:13:40 +05:30
Takeshi KOMIYA
598b85da75 Merge branch '3.x' into master 2020-10-04 22:41:44 +09:00
François Freitag
5166dd194c
Strip trailing whitespaces and normalize line endings 
Trailing whitespace do not have impact on the result, they are just
unused bytes. Most text editors are configured to strip trailing
whitespaces. Remove them all in one go.

Update a handful of files to use the UNIX line ending.
 2020-10-03 13:47:01 +02:00
Takeshi KOMIYA
068b9b5738 Merge branch '3.x' 2020-06-04 00:18:30 +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
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
2bd7c19c7b Drop python 3.5 support 2020-03-07 18:06:39 +09:00
Takeshi KOMIYA
93e519320b
Merge pull request #7227 from tk0miya/7217_docker 
Add a installation procedure for docker
 2020-02-29 16:35:15 +09:00
Takeshi KOMIYA
e6f8ed063c doc: Update installation 2020-02-29 16:22:55 +09:00
Takeshi KOMIYA
61b8edcb49 doc: Move docker section above "install from source" 2020-02-29 16:16:56 +09:00
Tetsuo Koyama
89490287e7
🆕 docker-sphinx 
Co-authored-by: tk0miya <i.tkomiya@gmail.com>
 2020-02-25 12:47:14 +09:00
Tetsuo Koyama
e20430aee1 🆕 docker-sphinx 2020-02-24 16:04:53 +09:00
Tetsuo Koyama
e3fa132f2b
⬆️ doc/usage/installation.rst 2020-02-24 16:00:47 +09:00
Tetsuo Koyama
14d8cf636a
🆕 docker-sphinx 2020-02-24 15:41:27 +09:00
Takeshi KOMIYA
34255f6014 doc: Recommend to use py38-sphinx instead of py36-sphinx 2020-02-24 12:43:51 +09:00
Takeshi KOMIYA
448937eb4d doc: Remove mention about py2 2020-02-24 12:43:00 +09:00
Dull Bananas
e24709c2df
Clarify Windows installation 2019-07-05 18:41:22 -07:00
Jon Dufresne
4e184754c9 Remove instructions to install Python 2 on Windows 
As only Python 3 is supported, should not advise users to install Python
2.
 2018-12-23 04:00:26 -08:00
Takeshi KOMIYA
ff8df59ac1
Merge pull request #5479 from jdufresne/https 
Prefer https:// links where available
 2018-09-24 09:04:54 +09:00
Jon Dufresne
dd383ec472 Prefer https:// links where available 2018-09-23 11:50:42 -07:00
Jon Dufresne
d9283a40d8 Correct installation docs about supported Python versions 
Since commit 9412bd76b7, older Python
versions have been dropped.
 2018-09-23 08:44:29 -07:00
Jon Dufresne
365c93f227 Update all pypi.python.org URLs to pypi.org 
For details on the new PyPI, see the blog post:

https://pythoninsider.blogspot.ca/2018/04/new-pypi-launched-legacy-pypi-shutting.html
 2018-04-18 19:51:48 -07:00
jfbu
9a20927593 Improve choice of lexers for highlighting in Installing Sphinx (docs) 
cf http://pygments.org/docs/lexers/#lexers-for-various-shells

The difference with prior situation shows more in PDF output (but for
Windows example visible already in html) than in HTML with used theme. I
am not sure why ``select`` is highlighted but not ``sudo`` but this was
case already before.
 2018-03-30 09:13:50 +02:00
Kenyon Ralph
7581e90dce
installation.rst: correct Windows Run keyboard shortcut 
You type Windows-R to get the Run dialog, not Control-R.
 2018-03-28 18:04:05 -07:00
jfbu
bde42595c6 Update installation docs 2018-03-17 22:56:53 +01:00
Stephen Finucane
cb4b7177d8 doc: Create usage guide section 
Start structuring our docs a little better starting with a usage guide.
There are a number of changes happening here. We're going to start with
the installation guide, which is simply moved to the appropriate
subdirectory.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-02-10 16:22:44 +00:00