Create devDocs using sphinx

devDocs/.gitignore

@@ -0,0 +1,2 @@
+_build/
+*.rst

devDocs/conf.py

@@ -0,0 +1,105 @@
+# A part of NonVisual Desktop Access (NVDA)
+# Copyright (C) 2019 NV Access Limited, Leonard de Ruijter
+# This file is covered by the GNU General Public License.
+# See the file COPYING for more details.
+
+# Configuration file for the Sphinx documentation builder.
+
+# -- Path setup --------------------------------------------------------------
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../source'))
+import sourceEnv  # noqa: F401, E402
+
+# Initialize languageHandler so that sphinx is able to deal with translatable strings.
+import languageHandler  # noqa: E402
+languageHandler.setLanguage("en")
+
+# Initialize globalvars.appArgs to something sensible.
+import globalVars  # noqa: E402
+
+
+class AppArgs:
+	# Set an empty comnfig path
+	# This is never used as we don't initialize config, but some modules expect this to be set.
+	configPath = ""
+	secure = False
+	disableAddons = True
+	launcher = False
+
+
+globalVars.appArgs = AppArgs()
+
+# Import NVDA's versionInfo module.
+import versionInfo  # noqa: E402
+# Set a suitable updateVersionType for the updateCheck module to be imported
+versionInfo.updateVersionType = "stable"
+
+# -- Project information -----------------------------------------------------
+
+project = versionInfo.name
+copyright = versionInfo.copyright
+author = versionInfo.publisher
+
+# The major project version
+version = versionInfo.formatVersionForGUI(
+	versionInfo.version_year,
+	versionInfo.version_major,
+	versionInfo.version_minor
+)
+
+# The full version, including alpha/beta/rc tags
+release = versionInfo.version
+
+# -- General configuration ---------------------------------------------------
+
+default_role = 'py:obj'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+	'sphinx.ext.autodoc',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = [
+	"_build"
+]
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.
+
+html_theme = "sphinx_rtd_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# -- Extension configuration -------------------------------------------------
+
+# sphinx.ext.autodoc configuration
+
+# Both the class’ and the __init__ method’s docstring are concatenated and inserted.
+autoclass_content = "both"
+autodoc_member_order = 'bysource'
+autodoc_mock_imports = [
+	"louis",  # Not our project
+]
+
+# Perform some manual mocking of specific objects.
+# autodoc can only mock modules, not objects.
+from sphinx.ext.autodoc.mock import _make_subclass  # noqa: E402
+
+import config  # noqa: E402
+# Mock an instance of the configuration manager.
+config.conf = _make_subclass("conf", "config")()

devDocs/devDocsInstall/.gitignore

@@ -0,0 +1 @@
+_executed_requirements.txt

devDocs/devDocsInstall/requirements.txt

@@ -0,0 +1,2 @@
+sphinx==2.2.2
+sphinx_rtd_theme

devDocs/devDocsInstall/sconscript

@@ -0,0 +1,35 @@
+###
+# This file is a part of the NVDA project.
+# URL: http://www.nvaccess.org/
+# Copyright 2019 NV Access Limited.
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2.0, as published by
+# the Free Software Foundation.
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+# This license can be found at:
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+###
+
+import sys
+
+Import("env")
+
+doInstall = env.Command(
+	"_executed_requirements.txt",  # $TARGET
+	"requirements.txt",   # $SOURCE
+	[
+		# Install deps from requirements file.
+		[
+			sys.executable, "-m", "pip",
+			"install", "--no-warn-script-location", "-r", "$SOURCE",
+		],
+		# Copy the requirements file, this is used to stop scons from
+		# triggering pip from attempting re-installing when nothing has
+		# changed. Pip takes a long time to determine that deps are met.
+		Copy('$TARGET', '$SOURCE')
+	]
+)
+
+Return('doInstall')