Commit Graph

61 Commits

Author SHA1 Message Date
Julien Palard 4067c6d7fe
gh-86404: Doc: Drop now unused make suspicious and rstlint. (GH-98179)
They have been replaced by
[sphinx-lint](https://github.com/sphinx-contrib/sphinx-lint).
2022-10-11 15:31:33 +02:00
Ezio Melotti 953ab07952
Restore default role check in `make check`. (#92290)
* Restore default role check in `make check`.

* Options first, then files.

* Update `make.bat` too.

* Add a comment explaining the extra options.

* No reason to ignore the README.rst.

* Enable default-role check in sphinx-lint.

Co-authored-by: Julien Palard <julien@palard.fr>

* Update sphinx-lint default-role check.

* Fix use of the default role in the docs.

* Update make.bat to check for the default role too.

* Fix comment in make.bat.

Co-authored-by: Julien Palard <julien@palard.fr>
2022-05-15 17:34:52 +02:00
Hugo van Kemenade 89c6b2b8f6
bpo-36329: Remove 'make -C Doc serve' in favour of 'make -C Doc htmlview' (GH-32354)
Also updated `make -C htmlview` so it used a full path with `file://`, because the original didn't open the page (macOS).

For example:
```sh
cd Doc

# Doesn't open anything:
python3 -c "import webbrowser; webbrowser.open('build/html/index.html')"

# Opens the docs page e.g. file:///Users/hugo/github/cpython/Doc/build/html/index.html :
python3 -c "import os, webbrowser; webbrowser.open('file://' + os.path.realpath('build/html/index.html'))"
```

https://bugs.python.org/issue36329
2022-04-29 15:47:26 +02:00
Steve Dower 295114dcd3
bpo-47138: Ensure Windows docs build uses the same pinned version as other platforms (GH-32161) 2022-03-28 21:38:31 +01:00
Julien Palard b878b3af0b
bpo-42238: [doc] moving from rstlint.py to sphinx-lint. (GH-31097) 2022-02-10 08:59:04 +01:00
Steve Dower fe5dd78182
Ensure correct version of Sphinx is used for Windows builds (GH-20582) 2020-06-01 22:17:23 +01:00
Steve Dower a76ba362c4
bpo-39041: Add GitHub Actions support (GH-17594) 2019-12-16 10:35:22 -08:00
Steve Dower 21a92f8cda
Implement Windows release builds in Azure Pipelines (GH-14065) 2019-06-14 08:29:20 -07:00
chrullrich e61cc481e0 bpo-35374: Avoid trailing space in hhc file name if found on PATH. (GH-10849) 2019-01-07 18:57:29 -08:00
Steve Dower afe17a7bee
bpo-35482: Fixes HTML escaping in CHM index and build location of NEWS file (GH-11224) 2018-12-19 18:20:06 -08:00
Steve Dower 0cd6391fd8
bpo-34977: Add Windows App Store package (GH-11027)
Also adds the PC/layout script for generating layouts on Windows.
2018-12-10 18:52:57 -08:00
Victor Stinner cb0b78a070
Revert "bpo-34977: Add Windows App Store package (GH-10245)" (GH-11019)
This reverts commit 468a15aaf9.
2018-12-07 12:57:43 +01:00
Steve Dower 468a15aaf9
bpo-34977: Add Windows App Store package (GH-10245) 2018-12-06 21:09:20 -08:00
Zachary Ware d824ca7f4d bpo-34006: Revert line length limit for Windows help docs (GH-8051)
The line-length limit is not needed because the pages appear in a separate app rather
 than on a browser tab.  It can also interact badly with the DPI setting.
2018-07-02 16:31:42 -04:00
Andrés Delfino 0e5f901508 bpo-33831: Make htmlview run again (GH-7628) 2018-06-11 09:58:18 -07:00
Andrés Delfino 05f1c8902c bpo-33696: Install python-docs-theme even if SPHINXBUILD is defined (GH-7242) 2018-05-30 09:08:25 -07:00
Andrés Delfino 8c1ad0c4f6 bpo-33670: Expose Sphinx errorlevel (GH-7156) 2018-05-28 16:28:22 -07:00
Andrés Delfino 3d3e66c2da bpo-33673: Install python-docs-theme even if Sphinx is already installed (GH-7163) 2018-05-28 16:20:34 -07:00
Steve Dower e5f41d2f1e
bpo-33522: Enable CI builds on Visual Studio Team Services (#6865) 2018-05-16 17:50:29 -04:00
Stefan Grönke f1502d097c bpo-31569: correct PCBuild/ case to PCbuild/ in build scripts and docs (GH-3711) 2017-09-25 17:58:10 +01:00
Steve Dower a4bb58fda4 Fix build issues in Doc/make.bat (#3658) 2017-09-19 12:31:28 -07:00
Steve Dower 5fcd5e64ee bpo-31340: Change to building with MSVC v141 (included with Visual Studio 2017) (#3311) 2017-09-06 10:01:38 -07:00
Steve Dower d5cd21d75a Fixes doc/make.bat to properly handle quoted paths. (#3302) 2017-09-04 14:26:27 -07:00
Steve Dower 68d663cf85 [bpo-30916] Pre-build OpenSSL and Tcl/Tk for Windows (#2688)
Updates ssl and tkinter projects to use pre-built externals
2017-07-17 11:15:48 +02:00
Zachary Ware 3f8f16d102 Show what's changed when Travis fails regen check (GH-2095)
Also fixed a few more line endings that were missed in GH-840, which were causing failure.
2017-06-10 23:04:36 -05:00
Roger b3f1f59cf4 Rename Doc/README.txt to Doc/README.rst and add formatting (#104)
* Reformat Doc/README.txt to Doc/README.rst

* Update mention of Doc/README.rst

* Update mention of README.txt to README.rst

* Make line fold

* rstlint ignore Doc/README.rst

* conf.py ignore Doc/README.rst

* Update issue tracker url in Docs/README.rst
2017-02-15 23:54:05 +01:00
Jim DeLaHunt 3d707be950 bpo-29521 Fix two minor documentation build warnings (#41)
Much of bpo-29521 was fixed in parallel with commit 
e7ffb99 .  This cleans up the rest.

Apply parallel change to Doc/make.bat to read 
"set SPHINXOPTS=-D latex_elements.papersize="
I don't have a Windows system on which to observe the warning,
but it should be necessary.

The warning:

.../workspace/cpython_github/Doc/faq/windows.rst:303: 
    WARNING: unknown option: -t

In the Windows FAQ, `How do I keep editors from inserting tabs 
into my Python source?`, contained a reference to a Python -t
option. In Python 2.x, this caused Python to issue warnings
about lines with mixed spaces and tabs, but as of Python 3.6
it does nothing. 
 
Per discussion at http://bugs.python.org/issue29387, take
their wording. Python [3] raises an IndentationError or 
TabError. Tabnanny is now a module.
2017-02-13 08:57:13 -05:00
Steve Dower 003e929cdb Prevents unnecessary help text appearing in doc build. 2016-09-06 10:49:17 -07:00
Steve Dower e1f6805776 Fixes argument handling in build.bat and HHC search 2015-07-20 21:34:45 -07:00
Zachary Ware 774ac377da Closes #17202: Merge with 3.4 2015-04-13 12:11:40 -05:00
Zachary Ware 4c9c848159 Issue #17202: Add .bat to .hgeol to force them to CRLF.
Using LF can a script to fail if it tries to use a label that is
split across 512 byte blocks.  Who knows why.
2015-04-13 11:59:54 -05:00
Steve Dower 312cef086b Improve Windows release scripts 2015-02-07 22:20:48 -08:00
Steve Dower bb24087a2c Issue #23260: Update Windows installer 2015-02-05 22:08:48 -08:00
Georg Brandl 61bd1dcf9b Move Doc/tools/sphinxext content to Doc/tools, there is no need for the nested subdirectory anymore. 2014-09-30 22:56:38 +02:00
Martin v. Löwis 78daf00e3f Amend b8ebf381390f: find patchlevel.py in extensions. 2015-02-09 08:07:12 +01:00
Georg Brandl 97e9ec688c Move Doc/tools/sphinxext content to Doc/tools, there is no need for the nested subdirectory anymore. 2014-09-30 22:51:30 +02:00
Zachary Ware 5989511183 Issue #21688: Give informative error message when hhc.exe cannot be found.
Initial patch by Olive Kilburn.
2014-06-10 12:07:45 -05:00
Zachary Ware a67b97f438 Issue #17386: Expand Doc/make.bat to be much more similar to Doc/Makefile 2014-04-29 09:45:33 -05:00
Zachary Ware a37ff0fb80 Issue #21289: Fix documentation building on Windows using Doc/make.bat.
Also fixes a long-standing typo in Doc/README.txt.

Initial patch by Dave Sawyer.
2014-04-18 15:10:40 -05:00
Georg Brandl f7b2f36f74 Doc: do not rely on checked-out Sphinx toolchain from svn.python.org anymore
Nowadays it is likely that people will have Sphinx installed,
and if not, they will know how to install it.

This also simplifies life a lot for distribution packagers,
who typically do not want the doc build process to connect
to external web resources.
2014-02-16 09:46:36 +01:00
Georg Brandl 8bd656ddb8 Closes #20258: Sphinx toolchain: move back to Jinja2 2.3.1 with support for Py2.5. 2014-01-14 12:00:45 +01:00
Georg Brandl 6392ad98d0 Doc: update Sphinx toolchain also in make.bat 2014-01-12 08:09:01 +01:00
Terry Jan Reedy ac356fcf8e Merge with 3.2: Issue #17386 2013-03-13 21:35:07 -04:00
Terry Jan Reedy 3b220e11eb Issue #17386 make.bat must run with Python 2 until Sphinx runs with Python 3.
If PYTHON is undefined, this fails without the launcher (installed with 3.3 or
from PyPI), but this is better than always failing. Patch from Zachary Ware.
2013-03-13 21:33:50 -04:00
Georg Brandl 0472bc8709 Use newer version of Pygments that handles "yield from". 2012-09-30 18:00:50 +02:00
Georg Brandl 49857f8a93 Add updated .hgeol file and fix newlines in the 3.2 branch. 2011-03-05 15:11:35 +01:00
Antoine Pitrou 7f1e174c7a Make svn:eol-style's more consistent 2011-02-25 14:19:48 +00:00
Georg Brandl 6dc50f34dd Update to 1.0.7. 2011-01-15 16:45:03 +00:00
Georg Brandl cfa8e29d1c Switch to Sphinx 1.0.5. 2010-11-12 08:09:11 +00:00
Georg Brandl 5ad8ed5f26 Update to Sphin 1.0.4. 2010-10-06 12:29:49 +00:00