← Back to team overview

ubuntu-packaging-guide-team team mailing list archive

[Merge] lp:~andrewsomething/ubuntu-packaging-guide/lp1093447 into lp:ubuntu-packaging-guide

 

Andrew Starr-Bochicchio has proposed merging lp:~andrewsomething/ubuntu-packaging-guide/lp1093447 into lp:ubuntu-packaging-guide.

Requested reviews:
  Ubuntu Packaging Guide Team (ubuntu-packaging-guide-team)
Related bugs:
  Bug #1091744 in Ubuntu Packaging Guide: "packaging guide should reference this bug list"
  https://bugs.launchpad.net/ubuntu-packaging-guide/+bug/1091744
  Bug #1093447 in Ubuntu Packaging Guide: "Missing license information in PDFs and EPUBs"
  https://bugs.launchpad.net/ubuntu-packaging-guide/+bug/1093447

For more details, see:
https://code.launchpad.net/~andrewsomething/ubuntu-packaging-guide/lp1093447/+merge/181926

This gets the license information into the PDFs and EPUBs. It also adds some text mentioning the LP project to the end of the index page so it is findable on the PDFs and EPUBs.

I also just figured out that the EPUB can use html templates just like the html version. Unfortunately, our html template doesn't work so well there. It really needs to be fluid for ebook readers. So for now, I enabled one of the themes shipped with Sphinx by default since the unthemed version we've been using is awfully ugly.
-- 
https://code.launchpad.net/~andrewsomething/ubuntu-packaging-guide/lp1093447/+merge/181926
Your team Ubuntu Packaging Guide Team is requested to review the proposed merge of lp:~andrewsomething/ubuntu-packaging-guide/lp1093447 into lp:ubuntu-packaging-guide.
=== modified file 'conf.py'
--- conf.py	2013-04-21 04:31:44 +0000
+++ conf.py	2013-08-23 20:53:29 +0000
@@ -42,7 +42,8 @@
 # General information about the project.
 project = u'ubuntu-packaging-guide'
 authors = 'Ubuntu Developers'
-copyright = u'2010-2013, '+authors
+licence = 'Creative Commons Attribution-ShareAlike 3.0'
+copyright = u'2010-2013 , ' + authors + ', ' + licence
 
 
 changelog = "debian/changelog"
@@ -219,8 +220,23 @@
 # If false, no module index is generated.
 #latex_domain_indices = True
 
+custom_preamble = u"""
+\\makeatletter
+    \\fancypagestyle{normal}{
+        \\fancyhf{}
+        \\fancyhead[LE,RO]{{\\py@HeaderFamily \\@title}}
+        \\fancyhead[LO]{{\\py@HeaderFamily\\nouppercase{\\rightmark}}}
+        \\fancyhead[RE]{{\\py@HeaderFamily\\nouppercase{\\leftmark}}}
+        \\fancyfoot[LE,RO]{{\\py@HeaderFamily\\thepage}}
+        \\fancyfoot[LO,RE]{\\footnotesize © %s}
+        \\renewcommand{\\headrulewidth}{0.4pt}
+        \\renewcommand{\\footrulewidth}{0.4pt}
+    }
+\\makeatother
+""" % copyright
+
 # Disable useless index in PDFs (only one item).
-latex_elements = {'printindex': ''}
+latex_elements = {'printindex': '', 'preamble': custom_preamble}
 
 # -- Options for manual page output --------------------------------------------
 
@@ -253,6 +269,8 @@
 epub_publisher = authors
 epub_copyright = copyright
 
+epub_theme = 'nature'
+
 # The language of the text. It defaults to the language option
 # or en if the language is not set.
 #epub_language = ''

=== modified file 'ubuntu-packaging-guide/index.rst'
--- ubuntu-packaging-guide/index.rst	2013-06-18 12:31:13 +0000
+++ ubuntu-packaging-guide/index.rst	2013-08-23 20:53:29 +0000
@@ -100,3 +100,10 @@
   — available in many languages;
 * `Packaging tutorial <http://www.debian.org/doc/manuals/packaging-tutorial/>`_ (also
   available as a `package <https://launchpad.net/ubuntu/+source/packaging-tutorial>`_).
+
+We are always looking to improve this guide. If you find any problems or have
+some suggestions, please `report a bug on Launchpad 
+<https://bugs.launchpad.net/ubuntu-packaging-guide>`_. If you'd like to help
+work on the guide, `grab the source
+<https://code.launchpad.net/~ubuntu-packaging-guide-team/ubuntu-packaging-guide/trunk>`_
+there as well.
\ No newline at end of file