diff options
| author | Sayed Adel <seiko@imavr.com> | 2021-07-25 05:08:25 +0200 |
|---|---|---|
| committer | Sayed Adel <seiko@imavr.com> | 2021-08-30 21:06:20 +0200 |
| commit | 1f56a455c0108b1670d5968f188e287a294b4f2e (patch) | |
| tree | 94e986cfcd1fcab034bccf52c565ca5bd045aa25 | |
| parent | f2a24d58d231d97bc60366a551bf718b5143ec3b (diff) | |
| download | numpy-1f56a455c0108b1670d5968f188e287a294b4f2e.tar.gz | |
DOC: Add release note for Doxygen
| -rwxr-xr-x | doc/preprocess.py | 3 | ||||
| -rw-r--r-- | doc/release/upcoming_changes/18884.new_feature.rst | 7 |
2 files changed, 9 insertions, 1 deletions
diff --git a/doc/preprocess.py b/doc/preprocess.py index a1f2d3f36..e88d9608e 100755 --- a/doc/preprocess.py +++ b/doc/preprocess.py @@ -17,7 +17,8 @@ def doxy_gen(root_path): if not os.path.exists(build_path): os.makedirs(build_path) with open(gen_path, 'w') as fd: - fd.write("#Please Don't Edit! This config file was autogenerated.\n") + fd.write("#Please Don't Edit! This config file was autogenerated by ") + fd.write(f"doxy_gen({root_path}) in doc/preprocess.py.\n") for c in confs: fd.write(c) diff --git a/doc/release/upcoming_changes/18884.new_feature.rst b/doc/release/upcoming_changes/18884.new_feature.rst new file mode 100644 index 000000000..41503b00e --- /dev/null +++ b/doc/release/upcoming_changes/18884.new_feature.rst @@ -0,0 +1,7 @@ +Generate C/C++ API reference documentation from comments blocks is now possible +------------------------------------------------------------------------------- +This feature depends on Doxygen_ in the generation process and on Breathe_ +to integrate it with Sphinx. + +.. _`Doxygen`: https://www.doxygen.nl/index.html +.. _`Breathe`: https://breathe.readthedocs.io/en/latest/ |