GithubHelp home page GithubHelp logo

API.md empty about jsii-docgen HOT 9 CLOSED

corrjo avatar corrjo commented on June 29, 2024
API.md empty

from jsii-docgen.

Comments (9)

eladb avatar eladb commented on June 29, 2024

assigning to @iliapolo

from jsii-docgen.

corrjo avatar corrjo commented on June 29, 2024

@iliapolo Any ideas or pointers to places I could dig?

from jsii-docgen.

iliapolo avatar iliapolo commented on June 29, 2024

@corrjo can you point me to your source code?

from jsii-docgen.

webratz avatar webratz commented on June 29, 2024

I see a similar issue with my project. Anyone found a solution here?

from jsii-docgen.

Chriscbr avatar Chriscbr commented on June 29, 2024

@webratz Can you provide a reproducible example or link to a repo perhaps?

I wonder if there's some kind of bug obtaining the JSII metadata.

from jsii-docgen.

webratz avatar webratz commented on June 29, 2024

Its sadly a non public project, but i can try tomorrow to build an example.
I think the important part is, that there is no standard root level export but sth like that

export * as ecr from './constructs/ecr';

from jsii-docgen.

austinwu avatar austinwu commented on June 29, 2024

I ran into the same issue in a few private projects, and also found that API.md misses any "submodule exports". I attempted to follow the same directory structure as projen, so I found it surprising that it didn't work as expected.

Here's a toy example: austinwu/projen-issues#1

from jsii-docgen.

Chriscbr avatar Chriscbr commented on June 29, 2024

Ahh, I see this is all because we don't generate docs in the root module by default. 🤦 So this is probably a symptom of #540

from jsii-docgen.

Chriscbr avatar Chriscbr commented on June 29, 2024

Hey @corrjo @webratz @austinwu - I believe this should be fixed in [email protected]. I'm closing this out, but feel free to @ me or create a new issue if you still run into problems. Thanks 🙂

from jsii-docgen.

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.