Browse Source

Updates for public docs.

pull/225/head
Vladimír Vondruš 8 years ago
parent
commit
875e22e730
  1. 6
      Doxyfile-mcss
  2. 16
      Doxyfile-public
  3. 2
      doc/mainpage.dox

6
Doxyfile-mcss

@ -76,6 +76,8 @@ HTML_EXTRA_STYLESHEET = \
https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600&subset=latin-ext \
../css/m-dark+doxygen.compiled.css
M_PAGE_HEADER = "<div class=\"m-note m-success\"><h3>No need to panic</h3><p>This is a snapshot of a work-in-progress documentation theme. If you feel lost, miss something, or want to see the original Doxygen docs instead, head over to the <a href="../../doc/html/{filename}">archived version of this documentation page</a>.</div>"
M_PAGE_HEADER = "<div class=\"m-note m-dim\">This is a snapshot of a work-in-progress documentation theme. If you feel lost, miss something, or want to see the original Doxygen docs instead, head over to the <a href="../../doc/html/{filename}">archived version of this documentation page</a>.</div>"
M_PAGE_FINE_PRINT = "<p>Magnum docs. Part of the <a href="http://magnum.graphics/">Magnum project</a>, copyright © Vladimír Vondruš 2010&ndash;2017. Generated by <a href="http://doxygen.org/">Doxygen</a> {doxygen_version} and <a href="http://mcss.mosra.cz/">m.css</a>. Contact the author via <a href="mailto:mosra@centrum.cz">e-mail</a>, <abbr title="mosra@jabbim.cz">Jabber</abbr>, <a href="https://twitter.com/czmosra">Twitter</a> or smoke signals.</p>"
M_PAGE_FINE_PRINT = "<p>Magnum docs. Part of the <a href="http://magnum.graphics/">Magnum project</a>, copyright © <a href="http://mosra.cz/">Vladimír Vondruš</a> and contributors, 2010&ndash;2018.<br />Generated by <a href="http://doxygen.org/">Doxygen</a> {doxygen_version} and <a href="http://mcss.mosra.cz/">m.css</a>. Contact the team via <a href="https://github.com/mosra/magnum">GitHub</a>, <a href="https://gitter.im/mosra/magnum">Gitter</a>, <a href="mailto:magnum-engine@googlegroups.com">e-mail</a> or <a href="https://twitter.com/czmosra">Twitter</a>.</p>"
# kate: hl Doxyfile

16
Doxyfile-public

@ -1,6 +1,7 @@
@INCLUDE = Doxyfile-mcss
## Patches for the m.css-generated docs. Just need to generate XML, that's it.
## Patches for the public docs. Hiding internal stuff, using a different
## stylesheet and relocating Corrade links to the public Corrade docs.
OUTPUT_DIRECTORY = build/doc-public/
GENERATE_TAGFILE = build/doc-public/magnum.tag
@ -71,10 +72,11 @@ ALIASES = \
GENERATE_TODOLIST = NO
GENERATE_BUGLIST = NO
# todo: re-enable when the site css is updated
#HTML_EXTRA_STYLESHEET = \
# https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600&subset=latin-ext \
# http://static.magnum.graphics/m-dark.compiled.css \
# http://static.magnum.graphics/m-dark.doxygen.compiled.css
HTML_EXTRA_STYLESHEET = \
https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600&subset=latin-ext \
http://static.magnum.graphics/m-dark.compiled.css \
http://static.magnum.graphics/m-dark.doxygen.compiled.css
M_PAGE_HEADER = "<div class=\"m-note m-success\"><h3>No need to panic</h3><p>This is a snapshot of a work-in-progress documentation theme. If you feel lost, miss something, or want to see the original Doxygen docs instead, head over to the <a href="http://doc.magnum.graphics/magnum-archive/{filename}">archived version of this documentation page</a>.</div>"
M_PAGE_HEADER = "<div class=\"m-note m-dim\">This is a snapshot of a work-in-progress documentation theme. If you feel lost, miss something, or want to see the original Doxygen docs instead, head over to the <a href="http://doc.magnum.graphics/magnum-archive/{filename}">archived version of this documentation page</a>.</div>"
# kate: hl Doxyfile

2
doc/mainpage.dox

@ -24,7 +24,7 @@
*/
namespace Magnum {
/** @mainpage
/** @mainpage Magnum
Magnum is a 2D/3D graphics engine written in C++11/C++14 and modern OpenGL. Its
goal is to simplify low-level graphics development and interaction with OpenGL

Loading…
Cancel
Save