Embed font files in Odoc

Remove the remote fonts from the default theme and instead embed them in
the theme.

This removes requests to Google's server that users might not consent
to.

The font files are part of the theme, they are affected by
'--without-theme' and are installed in 'share/odoc/odoc-theme/default/'.

Fira Mono and Fira Sans are from the latest release on https://github.com/mozilla/Fira
Noticia Text is from the latest release on Google Fonts.

src/html_support_files/LICENSE

@@ -55,3 +55,196 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+## fonts/FiraMono-Regular.woff2 and fonts/FiraSans-Regular.woff2 (version 4.202)
+
+Digitized data copyright (c) 2012-2015, The Mozilla Foundation and Telefonica S.A.
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
+
+## fonts/NoticiaText-Regular.ttf
+
+Copyright (c) 2011, JM Sole (http://jmsole.cl|[email protected]),
+with Reserved Font Name "Noticia Text".
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

src/html_support_files/dune

@@ -9,13 +9,29 @@
   (:x odoc_html_support_files.ml)
   (glob_files *.js)
   (glob_files *.css)
+  (glob_files_rec *.ttf)
   (glob_files_rec *.woff2))
  (action
   (progn
    (setenv
     SOURCE_DATE_EPOCH
     0
-    (run ocaml-crunch . -e js -e css -e woff2 -o %{x}.corrected -m plain -s))
+    (run
+     ocaml-crunch
+     .
+     -e
+     js
+     -e
+     css
+     -e
+     ttf
+     -e
+     woff2
+     -o
+     %{x}.corrected
+     -m
+     plain
+     -s))
    (diff? %{x} %{x}.corrected))))
 
 (library

src/html_support_files/odoc.css

@@ -4,9 +4,23 @@
    %%NAME%% %%VERSION%% */
 
 /* Fonts */
-@import url('https://fonts.googleapis.com/css?family=Fira+Mono:400,500');
-@import url('https://fonts.googleapis.com/css?family=Noticia+Text:400,400i,700');
-@import url('https://fonts.googleapis.com/css?family=Fira+Sans:400,400i,500,500i,600,600i,700,700i');
+@font-face {
+  font-family: 'Noticia Text';
+  font-weight: 400;
+  src: url('fonts/NoticiaText-Regular.ttf') format('truetype');
+}
+
+@font-face {
+  font-family: 'Fira Mono';
+  font-weight: 400;
+  src: url('fonts/FiraMono-Regular.woff2') format('woff2');
+}
+
+@font-face {
+  font-family: 'Fira Sans';
+  font-weight: 400;
+  src: url('fonts/FiraSans-Regular.woff2') format('woff2');
+}
 
 :root,
 .light:root {

src/odoc/dune

@@ -25,4 +25,13 @@
  (package odoc)
  (section share)
  (files
-  (../html_support_files/odoc.css as odoc-theme/default/odoc.css)))
+  (../html_support_files/odoc.css as odoc-theme/default/odoc.css)
+  (../html_support_files/fonts/FiraMono-Regular.woff2
+   as
+   odoc-theme/default/fonts/FiraMono-Regular.woff2)
+  (../html_support_files/fonts/FiraSans-Regular.woff2
+   as
+   odoc-theme/default/fonts/FiraSans-Regular.woff2)
+  (../html_support_files/fonts/NoticiaText-Regular.ttf
+   as
+   odoc-theme/default/fonts/NoticiaText-Regular.ttf)))

src/odoc/support_files.ml

@@ -1,5 +1,10 @@
 let should_include ~without_theme file =
-  if without_theme then match file with "odoc.css" -> false | _ -> true
+  if without_theme then
+    match file with
+    | "odoc.css" | "fonts/FiraMono-Regular.woff2"
+    | "fonts/FiraSans-Regular.woff2" | "fonts/NoticiaText-Regular.ttf" ->
+        false
+    | _ -> true
   else true
 
 let iter_files f ?(without_theme = false) output_directory =

test/integration/html_support_files.t/run.t

@@ -2,6 +2,8 @@
   $ find with-theme | sort
   with-theme
   with-theme/fonts
+  with-theme/fonts/FiraMono-Regular.woff2
+  with-theme/fonts/FiraSans-Regular.woff2
   with-theme/fonts/KaTeX_AMS-Regular.woff2
   with-theme/fonts/KaTeX_Caligraphic-Bold.woff2
   with-theme/fonts/KaTeX_Caligraphic-Regular.woff2
@@ -22,6 +24,7 @@
   with-theme/fonts/KaTeX_Size3-Regular.woff2
   with-theme/fonts/KaTeX_Size4-Regular.woff2
   with-theme/fonts/KaTeX_Typewriter-Regular.woff2
+  with-theme/fonts/NoticiaText-Regular.ttf
   with-theme/highlight.pack.js
   with-theme/katex.min.css
   with-theme/katex.min.js

test/pages/resolution.t/run.t

@@ -97,6 +97,8 @@ Let's also check the hierarchy of files produced:
 
   $ odoc support-files -o html
   $ find html -type f | sort
+  html/fonts/FiraMono-Regular.woff2
+  html/fonts/FiraSans-Regular.woff2
   html/fonts/KaTeX_AMS-Regular.woff2
   html/fonts/KaTeX_Caligraphic-Bold.woff2
   html/fonts/KaTeX_Caligraphic-Regular.woff2
@@ -117,6 +119,7 @@ Let's also check the hierarchy of files produced:
   html/fonts/KaTeX_Size3-Regular.woff2
   html/fonts/KaTeX_Size4-Regular.woff2
   html/fonts/KaTeX_Typewriter-Regular.woff2
+  html/fonts/NoticiaText-Regular.ttf
   html/highlight.pack.js
   html/katex.min.css
   html/katex.min.js