Skip to content

Support separate technical and user documentations #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Support separate technical and user documentations #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a0e3b7d
Support separate technical and user documentations (#6)
JulienCochuyt Oct 14, 2018
78bb31b
Merge branch 'master' into issue-6
JulienCochuyt Nov 6, 2019
1143fee
Merge branch 'master' into issue-6
JulienCochuyt May 5, 2020
9bdbcc8
Merge branch 'master' into issue-6
JulienCochuyt May 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
addon/doc/*.css
addon/doc/en/
*_docHandler.py
*.html
*.ini
Expand Down
5 changes: 5 additions & 0 deletions buildVars.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@
"addon_updateChannel": None,
}

# Specify whether this add-on provides a single documentation or separate
# technical and user documentations.
# If set to `True`, the `readme.md` file at the root of this project is used
# as the source for the user documentation in the base language.
useRootDocAsUserDoc = True

import os.path

Expand Down
2 changes: 1 addition & 1 deletion sconstruct
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ def createAddonHelp(dir):
cssPath = os.path.join(docsDir, "style.css")
cssTarget = env.Command(cssPath, "style.css", Copy("$TARGET", "$SOURCE"))
env.Depends(addon, cssTarget)
if os.path.isfile("readme.md"):
if buildVars.useRootDocAsUserDoc and os.path.isfile("readme.md"):
readmePath = os.path.join(docsDir, "en", "readme.md")
readmeTarget = env.Command(readmePath, "readme.md", Copy("$TARGET", "$SOURCE"))
env.Depends(addon, readmeTarget)
Expand Down