Skip to content

Dev docs: tell NVDA to treat source directory as app directory, allowing dev docs build with Sphinx to succeed #11972

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

Merged
michaelDCurran merged 3 commits into from
Jan 11, 2021
Merged

Dev docs: tell NVDA to treat source directory as app directory, allowing dev docs build with Sphinx to succeed #11972

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d179e77
Dev docs/config: point globalVars.appDir to source directory when bui…
josephsl Dec 25, 2020
f33d668
Dev docs/Sphinx config: update copyright header
josephsl Dec 25, 2020
1b9e97c
Dev docs/Sphinx config: address review comments.
josephsl Dec 27, 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
9 changes: 7 additions & 2 deletions devDocs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# A part of NonVisual Desktop Access (NVDA)
# Copyright (C) 2019 NV Access Limited, Leonard de Ruijter
# Copyright (C) 2019-2020 NV Access Limited, Leonard de Ruijter, Joseph Lee
# This file is covered by the GNU General Public License.
# See the file COPYING for more details.

Expand All @@ -16,7 +16,7 @@
import languageHandler # noqa: E402
languageHandler.setLanguage("en")

# Initialize globalvars.appArgs to something sensible.
# Initialize globalVars.appArgs to something sensible.
import globalVars # noqa: E402


Expand All @@ -30,6 +30,11 @@ class AppArgs:


globalVars.appArgs = AppArgs()
# #11971: NVDA is not running, therefore app dir is undefined.
# Therefore tell NVDA that apt source directory is app dir.
appDir = os.path.join("..", "source")
globalVars.appDir = os.path.abspath(appDir)


# Import NVDA's versionInfo module.
import versionInfo # noqa: E402
Expand Down