Skip to content

DOC: avoid searching some directories for doxygen-commented source code #29275

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
merged 3 commits into from
Jun 28, 2025
Merged

DOC: avoid searching some directories for doxygen-commented source code #29275

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0aa7bd7
DOC: avoid searching some directories for doxygen-commented source code
mattip Jun 26, 2025
a02dae9
lint [skip azp][skip actions][skip cirrus]
mattip Jun 26, 2025
10f9f8f
use known paths [skip azp][skip actions][skip cirrus]
mattip Jun 26, 2025
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
18 changes: 10 additions & 8 deletions doc/preprocess.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@


def main():
doxy_gen(os.path.abspath(os.path.join('..')))
doxy_gen(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))

def doxy_gen(root_path):
"""
Expand All @@ -24,6 +24,7 @@ def doxy_gen(root_path):
class DoxyTpl(Template):
delimiter = '@'


def doxy_config(root_path):
"""
Fetch all Doxygen sub-config files and gather it with the main config file.
Expand All @@ -35,13 +36,14 @@ def doxy_config(root_path):
conf = DoxyTpl(fd.read())
confs.append(conf.substitute(CUR_DIR=dsrc_path, **sub))

for dpath, _, files in os.walk(root_path):
if ".doxyfile" not in files:
continue
conf_path = os.path.join(dpath, ".doxyfile")
with open(conf_path) as fd:
conf = DoxyTpl(fd.read())
confs.append(conf.substitute(CUR_DIR=dpath, **sub))
for subdir in ["doc", "numpy"]:
for dpath, _, files in os.walk(os.path.join(root_path, subdir)):
if ".doxyfile" not in files:
continue
conf_path = os.path.join(dpath, ".doxyfile")
with open(conf_path) as fd:
conf = DoxyTpl(fd.read())
confs.append(conf.substitute(CUR_DIR=dpath, **sub))
return confs


Expand Down
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy