Comments (6)
Yeah, perhaps we could implement this feature, but it certainly isn't one we support right now. :)
from ex_doc.
I has having another problem with dialyzer jeremyjh/dialyxir#508 , and their solution was to add dialyzer to each child app. I tried that here and now I don't get the same error, but I'm getting an error for one of my apps ** (Mix) expected :name or :app to be found in the project definition in mix.exs
but there is a app
key in the project of that app.
from ex_doc.
Did you add ExDoc to child projects or to the root? Are you invoking it from the root or the child projects? How have you specified it?
from ex_doc.
Sorry, I originally had {:ex_doc, "~> 0.29", only: :dev, runtime: false},
. I tried changing it to {:ex_doc, "~> 0.30", only: :dev, runtime: false},
when I saw there was a newer version. Running mix docs
from the umbrella root gave me the original error I posted in the first message. Bumping the version still resulted in the same error.
Then I thought I'd add ex doc to each child, so I added {:ex_doc, "~> 0.30", only: :dev, runtime: false},
to every child application and then tried running mix docs
from the root again, and that's when I got the error about the :name or :app
from the second post above.
from ex_doc.
I cannot reproduce the error. mix docs
at the root always tells me missing ":name or :app", which is expected. You need to add it to every child and, if you want to run on all of them, you can do mix cmd mix docs
. :)
from ex_doc.
Ah, I incorrectly assumed that running mix docs
at the root would generate an aggregated doc at the root level. I was hoping to have all the documentation for the entire umbrella project together under one index.html
entry point.
from ex_doc.
Related Issues (20)
- Proposal: Custom markdown interpolation HOT 28
- Improve named typespec HOT 2
- Compilation warnings from `makeup_html` and `makeup_erlang` HOT 8
- Code within admonition block is hard to read in dark mode HOT 1
- Error generating docs for Elixir 1.15.2 HOT 4
- Elixir ExDocs Search index too big for SessionStorage HOT 5
- scroll to top on iOS
- Regression in headers on small screens HOT 4
- Proposal: --warnings-as-errors HOT 2
- ** (MatchError) no match of right hand side value: {:error, {:earmark, {'no such file or directory', 'earmark.app'}}} HOT 1
- Using `filter_modules` doesn't produce warning referencing `hidden or private` docs HOT 6
- Building docs for Erlang fails since v0.30.0 HOT 1
- Keyboard navigation: missing or inconsistent focus styles, some elements cannot be focused at all HOT 2
- `:skip_undefined_reference_warnings_on` with modules in pages HOT 2
- Annotate modules visually when `@moduledoc since: "..."` is present HOT 8
- Screen reader accessibility HOT 2
- Internal linking from one extra to another HOT 14
- Can't find publicly defined type from another module HOT 5
- Refactor warning generation HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ex_doc.