Skip to content

Commit

Permalink
docs: Build documentation with hotdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
thiblahute committed May 13, 2019
1 parent 5a2b935 commit 47a49f3
Show file tree
Hide file tree
Showing 301 changed files with 46,640 additions and 88,523 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Expand Up @@ -95,3 +95,6 @@ Build
# Meson
/build
/subprojects

# hotdoc
docs/hotdoc/libs/generated_sitemap.txt
8 changes: 2 additions & 6 deletions Makefile.am
@@ -1,12 +1,10 @@
DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc

SUBDIRS = \
gst-libs gst sys ext pkgconfig \
m4 common docs tests po tools
m4 common tests po tools

DIST_SUBDIRS = \
gst gst-libs sys ext pkgconfig \
m4 common docs tests po tools
m4 common tests po tools

EXTRA_DIST = \
depcomp \
Expand Down Expand Up @@ -46,7 +44,6 @@ CRUFT_FILES = \
$(top_builddir)/gst-plugins-bad.spec \
$(top_builddir)/common/shave \
$(top_builddir)/common/shave-libtool \
$(top_builddir)/docs/plugins/xml/plugin-sdp.xml \
$(top_builddir)/ext/alsaspdif/.libs/*.{so,dll,DLL,dylib} \
$(top_builddir)/ext/gtk/.libs/libgstgtksink.so \
$(top_builddir)/ext/gtk/.libs/libgstgtk.so \
Expand Down Expand Up @@ -102,7 +99,6 @@ CRUFT_FILES = \
$(top_builddir)/tests/icles/equalizer-test

CRUFT_DIRS = \
$(top_srcdir)/docs/plugins/tmpl \
$(top_srcdir)/gst/aacparse \
$(top_srcdir)/gst/amrparse \
$(top_srcdir)/gst/audiomixer \
Expand Down
8 changes: 0 additions & 8 deletions configure.ac
Expand Up @@ -138,10 +138,6 @@ AM_CONDITIONAL(HAVE_VALGRIND, test ! "x$VALGRIND_PATH" = "xno")
dnl check for gobject-introspection
GOBJECT_INTROSPECTION_CHECK([1.31.1])

dnl check for documentation tools
GTK_DOC_CHECK([1.12])
AG_GST_PLUGIN_DOCS([1.12])

dnl *** checks for libraries ***

dnl check for libm, for sin() etc.
Expand Down Expand Up @@ -2698,10 +2694,6 @@ ext/webrtcdsp/Makefile
ext/wpe/Makefile
ext/ttml/Makefile
po/Makefile.in
docs/Makefile
docs/plugins/Makefile
docs/libs/Makefile
docs/version.entities
pkgconfig/Makefile
pkgconfig/gstreamer-plugins-bad.pc
pkgconfig/gstreamer-plugins-bad-uninstalled.pc
Expand Down
19 changes: 0 additions & 19 deletions docs/Makefile.am

This file was deleted.

1 change: 1 addition & 0 deletions docs/gst_api_version.in
@@ -0,0 +1 @@
@GST_API_VERSION@
5 changes: 5 additions & 0 deletions docs/index.md
@@ -0,0 +1,5 @@
---
short-description: GStreamer Bad Plugins API reference.
...

# GStreamer Bad Plugins
28 changes: 0 additions & 28 deletions docs/libs/.gitignore

This file was deleted.

72 changes: 0 additions & 72 deletions docs/libs/Makefile.am

This file was deleted.

1 change: 1 addition & 0 deletions docs/libs/adaptivedemux/index.md
@@ -0,0 +1 @@
# Adaptive Demux library
1 change: 1 addition & 0 deletions docs/libs/adaptivedemux/sitemap.txt
@@ -0,0 +1 @@
c-index
3 changes: 3 additions & 0 deletions docs/libs/base/index.md
@@ -0,0 +1,3 @@
# Base classes from -bad

> NOTE: This library API is considered *unstable*
1 change: 1 addition & 0 deletions docs/libs/base/sitemap.txt
@@ -0,0 +1 @@
gi-index
7 changes: 7 additions & 0 deletions docs/libs/codecparsers/index.md
@@ -0,0 +1,7 @@
# Bitstream parsing Library

This library should be linked to by getting cflags and libs from
gstreamer-plugins-bad-{{ gst_api_version.md }}.pc and adding
-lgstcodeparsers-{{ gst_api_version.md }} to the library flags.

> NOTE: This library API is considered *unstable*
1 change: 1 addition & 0 deletions docs/libs/codecparsers/sitemap.txt
@@ -0,0 +1 @@
c-index
48 changes: 0 additions & 48 deletions docs/libs/compiling.sgml

This file was deleted.

102 changes: 0 additions & 102 deletions docs/libs/gst-plugins-bad-libs-docs.sgml

This file was deleted.

0 comments on commit 47a49f3

Please sign in to comment.