Skip to content

Commit 6617f39

Browse files
authored
Merge pull request #254 from schveiguy/tryddox
Try using ddox for doc generation
2 parents ebc6282 + 0de12b3 commit 6617f39

File tree

251 files changed

+25
-15929
lines changed

Some content is hidden

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

251 files changed

+25
-15929
lines changed

.github/workflows/docs.yml

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,26 @@ jobs:
2525

2626
- name: Build documentation
2727
run: |
28-
wget https://github.com/adamdruppe/adrdox/archive/master.zip
29-
unzip master.zip
30-
pushd adrdox-master && make && popd
31-
export PATH=$PATH:$PWD/adrdox-master
32-
doc2 --genSearchIndex --genSource -o generated-docs source
28+
# wget https://github.com/adamdruppe/adrdox/archive/master.zip
29+
# unzip master.zip
30+
# pushd adrdox-master && make && popd
31+
# export PATH=$PATH:$PWD/adrdox-master
32+
# doc2 --genSearchIndex --genSource -o generated-docs source
33+
34+
# no way to get dub to include a custom macro file, but we can
35+
# run ddox directly instead with the same command line, including
36+
# our custom macro file
37+
38+
# build original docs, this gets the json file properly set up
39+
dub -b ddox
40+
# remove docs generated without macro file
41+
rm -rf docs
42+
# regenerate the docs with the macros included
43+
dub run ddox -- generate-html --navigation-type=ModuleTree --std-macros=ddoc/macros.ddoc docs.json docs
3344
3445
- name: Deploy to Github Pages
3546
uses: JamesIves/[email protected]
3647
with:
37-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
48+
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
3849
BRANCH: gh-pages
39-
FOLDER: generated-docs
50+
FOLDER: docs

ddox/.editorconfig

Lines changed: 0 additions & 9 deletions
This file was deleted.

ddox/.gitignore

Lines changed: 0 additions & 14 deletions
This file was deleted.

ddox/.travis.yml

Lines changed: 0 additions & 9 deletions
This file was deleted.

ddox/LICENSE.txt

Lines changed: 0 additions & 7 deletions
This file was deleted.

ddox/LICENSE_DE.txt

Lines changed: 0 additions & 7 deletions
This file was deleted.

ddox/README-mysql-native.txt

Lines changed: 0 additions & 13 deletions
This file was deleted.

ddox/README.md

Lines changed: 0 additions & 85 deletions
This file was deleted.

ddox/dub.sdl

Lines changed: 0 additions & 21 deletions
This file was deleted.

ddox/public/images/ddox/alias.png

-253 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)