mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-03-28 11:55:39 +00:00
Use official hotdoc_lumen_theme instead of building it ourselves
This commit is contained in:
parent
e2a018290c
commit
0b2f7e860e
6 changed files with 8 additions and 42 deletions
3
.gitmodules
vendored
3
.gitmodules
vendored
|
@ -1,3 +0,0 @@
|
|||
[submodule "hotdoc_bootstrap_theme"]
|
||||
path = theme/hotdoc_bootstrap_theme
|
||||
url = git@github.com:hotdoc/hotdoc_bootstrap_theme.git
|
13
Makefile
13
Makefile
|
@ -28,19 +28,6 @@ gst_docs_HOTDOC_FLAGS = \
|
|||
--conf-file hotdoc.json \
|
||||
$(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
|
||||
|
||||
-include $(shell $(HOTDOC) --makefile-path)
|
||||
|
|
20
README.md
20
README.md
|
@ -27,24 +27,6 @@ for *stable* automatic formatting.
|
|||
* We *experimentally* use the hotdoc C extension to include functions by
|
||||
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:
|
||||
|
||||
```
|
||||
|
@ -54,7 +36,7 @@ make
|
|||
* And browse it:
|
||||
|
||||
```
|
||||
xdg-open built_doc/html/index.html
|
||||
gio open built_doc/html/index.html
|
||||
```
|
||||
|
||||
## Licensing
|
||||
|
|
12
hotdoc.json
12
hotdoc.json
|
@ -1,20 +1,20 @@
|
|||
{
|
||||
"project_version": "1.0",
|
||||
"add_anchors": true,
|
||||
"add_anchors": true,
|
||||
"extra_assets": [
|
||||
"images"
|
||||
],
|
||||
],
|
||||
"index": "markdown/index.md",
|
||||
"output": "built_doc",
|
||||
"output": "built_doc",
|
||||
"pkg_config_packages": [
|
||||
"gstreamer-1.0"
|
||||
],
|
||||
],
|
||||
"project_name": "GStreamer Documentation",
|
||||
"project_version": "1.0",
|
||||
"sitemap": "sitemap.txt",
|
||||
"sitemap": "sitemap.txt",
|
||||
"syntax_highlighting_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",
|
||||
"include_paths": ["examples"]
|
||||
}
|
||||
|
|
1
theme/extra/templates/brand-logo.html
Normal file
1
theme/extra/templates/brand-logo.html
Normal file
|
@ -0,0 +1 @@
|
|||
<img src="assets/images/gstreamer-logo.svg" alt="Home">
|
|
@ -1 +0,0 @@
|
|||
Subproject commit 2a78a9b4957f90f82755026f0e4791e53a4f0cd5
|
Loading…
Reference in a new issue