Paolo Melchiorre
0977ec671a
Added parallelism support via --jobs to docs build Makefile rule.
2024-11-27 18:15:25 -03:00
Paolo Melchiorre
2d612162d8
Used webbroswer module in docs Makefile.
2024-10-24 10:45:44 +02:00
Mariusz Felisiak
6015bab80e
Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs.
...
This adds:
- GitHub actions,
- tox configuration,
- pre-commit hook, and
- makefile rules
to run blacken-docs linter.
Co-authored-by: David Smith <smithdc@gmail.com>
2023-03-01 13:02:57 +01:00
Mariusz Felisiak
565ad5ace4
Fixed #33753 -- Fixed docs build on Sphinx 5+.
...
Empty language is not supported anymore.
2022-06-01 12:13:15 +02:00
Dmitry Shachnev
f370bfb108
Fixed docs build with Sphinx 1.6.
2017-05-24 09:13:26 -04:00
Berker Peksag
b327a614eb
Added an "htmlview" target to open docs after building them.
...
This is helpful if you build and test documentation updates in
your development env.
Copied from CPython's Doc/Makefile.
2014-12-08 07:23:34 -05:00
Szczepan Cieślik
a0f2525202
Fixed #22141 -- Added a spelling checker for documentation.
2014-03-07 09:29:23 -05:00
minusf
c694e6220e
Allowed overriding variables in docs/Makefile.
2013-07-29 06:51:54 -04:00
Claude Paroz
6a092f24e0
Allow build of translated documentation
2013-06-08 16:13:51 +02:00
Tim Graham
9b5f64cc6e
Fixed #19516 - Fixed remaining broken links.
...
Added -n to sphinx builds to catch issues going forward.
2013-01-02 18:32:57 -05:00
Claude Paroz
a79d920a56
Fixed #19266 -- Added Texinfo documentation target
...
Thanks orontee for the report and initial patch.
2012-11-09 09:00:27 +01:00
Claude Paroz
393aeb79b8
Added gettext target to sphinx makefiles.
...
This have been copied from sphinx-quickstart result in latest sphinx versions.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17877 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-04-07 22:35:57 +00:00
Jannis Leidel
fad4a93275
Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0.
...
git-svn-id: http://code.djangoproject.com/svn/django/trunk@13446 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-07-24 10:21:21 +00:00
Luke Plant
b09581394e
Added hyperlinks for builtin template tags and filters to code samples in docs.
...
Implemented in javascript because doing it 'properly' is pretty much impossible with Sphinx and Pygments.
Refs #12249
git-svn-id: http://code.djangoproject.com/svn/django/trunk@13135 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-05-08 14:31:20 +00:00
Russell Keith-Magee
9338ad0f2e
Fixed #13484 -- Added some newly available targets to the documentation makefile. Thanks to Alex for the patch.
...
git-svn-id: http://code.djangoproject.com/svn/django/trunk@13126 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-05-08 07:30:53 +00:00
Jacob Kaplan-Moss
97cb07c3a1
Massive reorganization of the docs. See the new docs online at http://docs.djangoproject.com/ .
...
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8506 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-23 22:25:40 +00:00
Jacob Kaplan-Moss
7dd4be581b
Added the basics needed to build Django's docs using [ http://sphinx.pocoo.org/ Sphinx]. If you've got Sphinx installed (the latest version) along with [ http://docutils.sf.net docutils], you should be able to easily build the docs locally using {{{sphinx-build}}} or the included {{{Makefile}}}. This use a basic (and pretty crappy) index for the documentation and the built-in Sphinx styles (which are actually quite nice).
...
git-svn-id: http://code.djangoproject.com/svn/django/trunk@7370 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-03-27 15:03:52 +00:00
