Giter Club home page Giter Club logo

Comments (3)

mloskot avatar mloskot commented on June 30, 2024 1

@svenevs Thanks a lot for your suggestion to downgrade to Sphinx 1.7.9. This helped Exhale to complete generating the docs without any crashes.

I'll follow-up with some more details soon.

from exhale.

mloskot avatar mloskot commented on June 30, 2024 1

@svenevs (/cc @stefanseefeld)
Yes, and currently Doxygen generates docs for everything, including the detail namespace. We are going to limit that to the public definitions only, https://lists.boost.org/boost-gil/2018/11/0118.php

To follow up the chat on Gitter/Slack:

do you intend to keep the doxyfile separate or put the doxygen configs in conf.py
For smaller projects I suggest the latter, but for bigger projects it can be nice to keep separate.

I'd prefer to keep Doxyfile separate indeed.

When you say exclude detail namespace, do you mean entirely or just from the tree view listings? Both are possible

First, I'd exclude the detail entirely.
I think, for learning Exhale, it is a good idea to get rid of non-public definitions completely.

Once we work the configurations out, we can try to offer two types of documentations:

  • User-oriented with public only
  • Developer-oriented with public + internal

I'll find where breathe/exhale/Sphinx are choking and post back.

During the successful run last night, I noticed huge red log related to the C++ code parsing.
There are also ~3500 warnings from Doxygen about undocumented members.
Shortly, GIL's inline documentation may simply be lacking, badly formed, and we aim to clean it up gradually. Meanwhile, I can only apologies for the shitty input we feed Doxygen with :-)


BTW, I'm on 64 GB RAM and possibly I did not notice the DOM memory issues. However, I can see GIL pushes Sphinx and Exhale to the limits :)

from exhale.

svenevs avatar svenevs commented on June 30, 2024

Ok cool thanks! I'm testing things locally right now. This project is huge by the way.

What you said about excluding the detail namespace may be necessary (at least at this time). The parser for breathe uses minidom which has memory leaks, we're switching to lxml. This one has taken a lot of time and effort because we also need to fix the testing suite x0

from exhale.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.