Giter Club home page Giter Club logo

Comments (7)

mortenpi avatar mortenpi commented on June 11, 2024 1

I think this was a design decision

It seems like a good default though, because you can always add submodules by hand in Modules, but you can't remove them if they're included implicitly. But it could be nice to have some syntax here to "expand" recursively to all submodules. And we should probably also document this behavior explicitly -- I don't think we do right now.

from documenter.jl.

mortenpi avatar mortenpi commented on June 11, 2024

Bit of a guess, but what happens if you do

```@autodocs
Modules = [Crossterm, Crossterm.CursorStyle, Crossterm.ClearType]
```

?

from documenter.jl.

kdheepak avatar kdheepak commented on June 11, 2024

Weirdly I'm not able to reproduce this locally:

image

from documenter.jl.

kdheepak avatar kdheepak commented on June 11, 2024

Explicitly specifying it solves the problem.

https://github.com/kdheepak/Crossterm.jl/actions/runs/8431301904/job/23088490229

I'm happy to close this issue but I'm still not sure why this happens? Does Documenter not handle recursive modules?

from documenter.jl.

goerz avatar goerz commented on June 11, 2024

Does Documenter not handle recursive modules

It does not. I think this was a design decision

from documenter.jl.

mortenpi avatar mortenpi commented on June 11, 2024

Weirdly I'm not able to reproduce this locally:

Your're just running doctests. That doesn't try to build the whole manual, and therefore doesn't check for missing docstrings etc.

from documenter.jl.

kdheepak avatar kdheepak commented on June 11, 2024

I thought I ran the same command I was running on GitHub actions. I believe @enumx creates a Module, so it would be nice to recursively expand it.

from documenter.jl.

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.