Skip to content

Commit 352a257

Browse files
committed
Rework doc generation
fix Guake#1271 Signed-off-by: Gaetan Semet <[email protected]>
1 parent 20f3aed commit 352a257

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+664
-402
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ __pycache__
6767
dist/
6868
*.egg-info/
6969
build/
70+
docs/_build/
7071

7172
AUTHORS
7273
ChangeLog

Makefile

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ ROOT_DIR=$(shell pwd)
1717
DATA_DIR=$(ROOT_DIR)/guake/data
1818
COMPILE_SCHEMA:=1
1919

20+
datarootdir:=$(prefix)/share
21+
datadir:=$(datarootdir)
22+
localedir:=$(datarootdir)/locale
23+
gsettingsschemadir:=$(datarootdir)/glib-2.0/schemas
2024

2125
AUTOSTART_FOLDER:=~/.config/autostart
2226

@@ -26,11 +30,6 @@ DEV_GLADE_DIR:=$(DATA_DIR)
2630
DEV_SCHEMA_DIR:=$(DATA_DIR)
2731
DEV_GUAKE_THEME_DIR:=$(DATA_DIR)/themes
2832

29-
datarootdir:=$(prefix)/share
30-
datadir:=$(datarootdir)
31-
localedir:=$(datarootdir)/locale
32-
gsettingsschemadir:=$(datarootdir)/glib-2.0/schemas
33-
3433
SHARE_DIR:=$(datadir)/guake
3534
GUAKE_THEME_DIR:=$(SHARE_DIR)/guake
3635
LOGIN_DESTOP_PATH = $(SHARE_DIR)
@@ -218,8 +217,11 @@ test-coverage:
218217
sct: style check update-po requirements test
219218

220219

221-
docs: clean-docs
222-
cd doc && pipenv run make html
220+
docs: clean-docs sdist
221+
cd docs && pipenv run make html
222+
223+
docs-open:
224+
xdg-open docs/_build/html/index.html
223225

224226
tag-pbr:
225227
@{ \
@@ -290,7 +292,7 @@ clean-po:
290292
@find po -name "*.mo" -exec rm -f {} \;
291293

292294
clean-docs:
293-
rm -rf doc/build
295+
rm -rf doc/_build
294296

295297
update-po:
296298
@find guake -iname "*.py" | xargs xgettext --from-code=UTF-8 --output=guake-python.pot

Pipfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ reno = {version = ">=2.8.0", extras = ["sphinx"]}
2121
pipenv-to-requirements = "*"
2222
colorlog = "*"
2323
rope = "*"
24+
sphinx-rtd-theme = "*"
2425

2526
[packages]
2627
pbr = "*"

Pipfile.lock

Lines changed: 26 additions & 22 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)