build: add requirements.txt and use venv to build docs
This commit is contained in:
parent
5142d9bedc
commit
6015bd1a42
|
@ -169,3 +169,6 @@ subprojects/*sass*.wrap
|
|||
|
||||
#VS Code config
|
||||
.vscode
|
||||
|
||||
# Python related files
|
||||
venv
|
||||
|
|
16
HACKING.md
16
HACKING.md
|
@ -317,6 +317,22 @@ git-packaging-hooks for more information.
|
|||
git fetch <name>
|
||||
git merge <name>/<branch-name>
|
||||
|
||||
# Building User and Dev Docs
|
||||
|
||||
# Create a virtual environment (if not already created)
|
||||
# This will create a new directory called venv
|
||||
# Skip this step if an environment is already there
|
||||
python -m venv venv
|
||||
|
||||
# Enable the virtual environment
|
||||
. ./venv/bin/activate
|
||||
|
||||
# Install required python libraries in the environment
|
||||
install -r requirements.txt
|
||||
|
||||
# Build the user docs (bundled manual)
|
||||
ninja -C build manual_bundle
|
||||
|
||||
# Coding Guidelines
|
||||
## Commenting
|
||||
Please document everything specified in header files
|
||||
|
|
|
@ -103,7 +103,7 @@ meson_build_root = meson.current_build_dir ()
|
|||
prog_name = get_option ('program_name')
|
||||
prog_name_lowercase = prog_name.to_lower()
|
||||
copyright_name = 'The ' + prog_name + ' contributors'
|
||||
copyright_years = '2018-2022'
|
||||
copyright_years = '2018-2023'
|
||||
|
||||
prefix = get_option ('prefix')
|
||||
bindir = prefix / get_option ('bindir')
|
||||
|
|
|
@ -0,0 +1,29 @@
|
|||
alabaster==0.7.13
|
||||
Babel==2.12.1
|
||||
beautifulsoup4==4.12.2
|
||||
certifi==2023.7.22
|
||||
charset-normalizer==3.2.0
|
||||
click==8.1.6
|
||||
docutils==0.20.1
|
||||
furo==2023.7.26
|
||||
idna==3.4
|
||||
imagesize==1.4.1
|
||||
Jinja2==3.1.2
|
||||
MarkupSafe==2.1.3
|
||||
packaging==23.1
|
||||
Pygments==2.16.1
|
||||
requests==2.31.0
|
||||
snowballstemmer==2.2.0
|
||||
soupsieve==2.4.1
|
||||
Sphinx==7.1.2
|
||||
sphinx-basic-ng==1.0.0b2
|
||||
sphinx-copybutton==0.5.2
|
||||
sphinx-intl==2.1.0
|
||||
sphinxcontrib-applehelp==1.0.6
|
||||
sphinxcontrib-devhelp==1.0.4
|
||||
sphinxcontrib-htmlhelp==2.0.3
|
||||
sphinxcontrib-jsmath==1.0.1
|
||||
sphinxcontrib-qthelp==1.0.5
|
||||
sphinxcontrib-serializinghtml==1.1.7
|
||||
sphinxcontrib-svg2pdfconverter==1.2.2
|
||||
urllib3==2.0.4
|
Loading…
Reference in New Issue