rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-05-14 22:09:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
662 Commits 3 Branches 7 Tags
Commit Graph

28 Commits

Author SHA1 Message Date
Sebastian Huber
5d7921bebc common: Show page references after internal links 
The custom RTEMS extension produced quite verbose references like
"Chapter 3 - Section 7 - Bla blub".  This may distract the reading flow.
Use a standard Sphinx option to show page references instead, e.g. "Bla
blub (page 11)".  This has some value for printed out documents.
 2019-08-14 07:27:00 +02:00
Chris Johns
ec95748f03 Remove minted from the PDF builds. 
This is feedback from the Sphinx project. See:

https://github.com/sphinx-doc/sphinx/issues/6021#issuecomment-460951653
 2019-02-13 08:52:01 +11:00
Chris Johns
a3b0a40880 Fix building with Sphinx 1.8 and later. 
- Provide the pytnon.ist file for makeindex.

- Add support for xelatex building so we can switch if we want too.

Closes #3669
 2019-02-06 17:02:18 +11:00
Sebastian Huber
d9eb36b097 Change first copyright year to 1988 
The OAR copyright goes back to 1988.
 2019-01-18 09:54:36 +01:00
Sebastian Huber
cd408b5a8b Update general copyright notice 
Update year and add "and contributors".
 2019-01-09 09:24:02 +01:00
Sebastian Huber
3202e319a1 Replace build date with Git hash and commit date 
The usage of a build date prevents reproducible builds.
 2019-01-09 09:23:58 +01:00
Chris Johns
969e60e596 Update the copyright year. 2018-10-19 14:42:12 +11:00
Chris Johns
471c5e380f pdf: Revert the changes to the Latex index formatting. 
I removed the '_' splitting of long labels from the index when testing
and this puts it back.
 2018-08-21 13:55:03 +10:00
Chris Johns
5ce8e43506 build: Fix indexing so it works on HTML and PDF. 
- Remove all genindex.rst files, these are generated and should not
  exist in our source.
- Fix the HTML templates so the local specialisation works.
- Add a index link to the sidebar for HTML.

Note, there is no TOC entry for the index in the PDF output and I
cannot figure out how to add one.

Closes #3503
 2018-08-21 13:47:40 +10:00
Sebastian Huber
5fc9f8bc42 common: Remove obsolete latex_use_parts 
This configuration is obsolete and no longer documented:

http://www.sphinx-doc.org/en/stable/config.html#options-for-latex-output

The use of parts at the top-level results in ugly documents.
 2017-08-25 14:28:27 +02:00
Chris Johns
7464b71b59 common/conf: Clean up. 2017-08-11 13:45:41 +10:00
Chris Johns
e7f009e549 conf: Update the copyright year. 2017-03-21 08:41:55 +11:00
Chris Johns
f97be09daf Use a single top level version number. 2017-03-20 12:18:53 +11:00
Sebastian Huber
c1dddacbee Move extensions to common conf.py 2017-02-22 07:09:21 +01:00
Sebastian Huber
3966353b33 Do not show page references after internal links 2017-02-01 09:48:31 +01:00
Justin Powell
876035b7bd conf.py: Fix build_date() to append correct suffix on all days. 2017-01-11 19:24:46 -06:00
Chris Johns
daea85e3b2 pdf: Format lists for directives to sit on the next line. 2016-11-08 15:28:32 +11:00
Chris Johns
64a3db7073 conf: Make the build date use a nicer day format. 2016-11-03 14:41:39 +11:00
Chris Johns
ce4daf9fd9 Add a copyright to the PDF front page. 2016-11-02 16:34:32 +11:00
Chris Johns
761b082f37 waf: Add a build date to the copyright. 2016-10-30 12:36:30 +11:00
Amar Takhar
2bcd424b4b Switch to using Minted and splitting long lines in verbatim. 2016-05-02 20:51:26 -04:00
Chris Johns
7130ed3229 Fix PDF layout. 2016-05-02 20:51:25 -04:00
Chris Johns
c18d76ae55 Add my-style.css support and add RTEMS to that CSS. 2016-05-02 20:51:25 -04:00
Amar Takhar
a316b1ff6d Add support for singlehtml (inlined) HTML file, plus some other fixes. 
* This is still broken.
  * Rename sphinx_rtd_theme so it doesn't pickup locally installed ones
  * Add a hack to theme.css to get around inliner bug.
  * Some unrelated fixups in common/waf.py

Unfortunatly several dozen fixes got merged into this.
 2016-05-02 20:51:25 -04:00
Amar Takhar
9b5801a6e6 Add PDF generation support use with --pdf 2016-05-02 20:51:24 -04:00
Amar Takhar
3a717592a9 Rework how conf.py is handled. 
Needed to switch due to increasing complexity.
 2016-05-02 20:51:24 -04:00
Amar Takhar
46498bd4e3 Fix rtemsconfig building. 
I'll probably move to a more pythonic way of doing conf.py since this is getting
too complicated.
 2016-05-02 20:51:24 -04:00
Amar Takhar
5daabd23cf Initial reST documentation using Sphinx. 2016-05-02 20:51:07 -04:00