0

I am using Doxygen to document a Python package. The package contains a subpackage called core that contains a module called models. I can refer to this module with @ref core.models however my output file shows "core::models". Is there an easy way to make my output show "core.models" instead?

Possible solutions:

  • Use @ref core.models "core.models" but it's a little tedious to write every module name twice.
  • Set HIDE_SCOPE_NAMES = YES in which case my output just shows "models", which resolves the issue of having the non-Pythonic :: but introduces ambiguity (i.e. the reader no longer knows which package it belongs to).

I'm using a pre-release version of Doxygen 1.14.0 (e0653197fd6bf9800f708ef02e09094d91778445*)

I have the following non-default Doxyfile settings.

PYTHON_DOCSTRING       = NO
OPTIMIZE_OUTPUT_JAVA   = YES
HIDE_COMPOUND_REFERENCE= YES
Improve this question
4
  • Just out of curiosity (and not answering you question in any way), do you have to use Doxygen, or was it a particular choice you made? For Python package documentation, I'd generally go with sphinx or mkdocs. These were both designed for python packages, whereas doxygen is more general purpose. Commented Jun 5 at 13:10
  • As it is python it should write out core.models but apparently a place has not been taken into account in doxygen. Please file a issue / bug report at github.com/doxygen/doxygen/issues with attached a, small, self contained example (source+configuration file in a, compressed, tar or zip file!) that allows us to reproduce the problem? Please don't add external links as they might not be persistent (also references to GitHub repositories are considered non persistent). Commented Jun 5 at 13:25
  • @MattPitkin I chose to use Doxygen for two reasons. Firstly, I am familiar with it from previous (non-Python) work. Secondly, I like how it looks with the doxygen-awesome-css theme. Neither of these are very good reasons. At some point, I hope to investigate Sphinx. Commented Jun 15 at 19:40
  • @albert Just submitted issue #11619 on GitHub. Sorry for the typical slow reply time. Thanks for your help! Commented Jun 15 at 19:49
Related questions
7
Document function-like macros without evaluating if/else with Doxygen
149
How to make an introduction page with Doxygen
66
Excluding directories for Doxygen
Load 5 more related questions Show fewer related questions

0

Reset to default

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.