mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-04-26 06:54:49 +00:00
Code Issues 1 Projects Releases Wiki Activity

Use official hotdoc_lumen_theme instead of building it ourselves

Browse source
This commit is contained in:
Thibault Saunier 2018-08-27 14:45:17 -03:00
parent e2a018290c
commit 0b2f7e860e
6 changed files with 8 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
.gitmodules vendored
View file

@ -1,3 +0,0 @@
[submodule "hotdoc_bootstrap_theme"]
path = theme/hotdoc_bootstrap_theme
url = git@github.com:hotdoc/hotdoc_bootstrap_theme.git

13
Makefile
View file

@ -28,19 +28,6 @@ gst_docs_HOTDOC_FLAGS = \
--conf-file hotdoc.json \ --conf-file hotdoc.json \
$(NULL) $(NULL)
theme/theme.stamp: theme/less/variables.less
+make -C theme/hotdoc_bootstrap_theme LESS_INCLUDE_PATH=$$PWD/theme/less
@rm -rf hotdoc-private*
@touch theme/theme.stamp
clean_theme:
rm -f theme/theme.stamp
+make -C theme/hotdoc_bootstrap_theme clean
clean: clean_theme
gst_docs_HOTDOC_EXTRA_DEPS = theme/theme.stamp
.PHONY: all install clean .PHONY: all install clean
-include $(shell $(HOTDOC) --makefile-path) -include $(shell $(HOTDOC) --makefile-path)

20
README.md
View file

@ -27,24 +27,6 @@ for *stable* automatic formatting.
* We *experimentally* use the hotdoc C extension to include functions by * We *experimentally* use the hotdoc C extension to include functions by
name, follow the steps outlined [here](https://github.com/hotdoc/hotdoc_c_extension) name, follow the steps outlined [here](https://github.com/hotdoc/hotdoc_c_extension)
* We recompile and override hotdoc's default theme, which is a submodule of this project:
```
git submodule update --init
```
Follow the instructions outlined in the theme's README.md, you can dispense
with the last step (building the theme):
```
cd theme/hotdoc_bootstrap_theme
sudo dnf install nodejs # On Fedora
sudo apt-get install nodejs nodejs-legacy npm # debian
sudo pacman -S nodejs npm # arch
npm install && ./node_modules/bower/bin/bower install
cd ../..
```
* Build the portal: * Build the portal:
``` ```
@ -54,7 +36,7 @@ make
* And browse it: * And browse it:
``` ```
xdg-open built_doc/html/index.html gio open built_doc/html/index.html
``` ```
## Licensing ## Licensing

12
hotdoc.json
View file

@ -1,20 +1,20 @@
{ {
"project_version": "1.0", "project_version": "1.0",
"add_anchors": true, "add_anchors": true,
"extra_assets": [ "extra_assets": [
"images" "images"
], ],
"index": "markdown/index.md", "index": "markdown/index.md",
"output": "built_doc", "output": "built_doc",
"pkg_config_packages": [ "pkg_config_packages": [
"gstreamer-1.0" "gstreamer-1.0"
], ],
"project_name": "GStreamer Documentation", "project_name": "GStreamer Documentation",
"project_version": "1.0", "project_version": "1.0",
"sitemap": "sitemap.txt", "sitemap": "sitemap.txt",
"syntax_highlighting_activate": true, "syntax_highlighting_activate": true,
"devhelp_activate": true, "devhelp_activate": true,
"html_theme": "theme/hotdoc_bootstrap_theme/dist", "html_theme": "https://github.com/hotdoc/hotdoc_lumen_theme/releases/download/0.6/hotdoc_lumen_theme-0.6.tar.xz?sha256=0e2f175f4cf8c00ed7ac5014e30c806a294b0d3818565eb74e1424a948e8a452",
"html_extra_theme": "theme/extra", "html_extra_theme": "theme/extra",
"include_paths": ["examples"] "include_paths": ["examples"]
} }

1
theme/extra/templates/brand-logo.html Normal file
View file

@ -0,0 +1 @@
<img src="assets/images/gstreamer-logo.svg" alt="Home">

1
theme/hotdoc_bootstrap_theme

@ -1 +0,0 @@
Subproject commit 2a78a9b4957f90f82755026f0e4791e53a4f0cd5