Comments (4)
I'm not sure to understand how elm-doc-preview
is involved. Are you able to compile your package ?
elm-doc-preview
will simply run elm make --docs=/tmp/docs.json
in the directory where it is started (or the one passed as an optional argument). Are you able to run this command manually?
from elm-doc-preview.
So we have an internal package that we use in all of our apps through submodules. We forked elm-menu and included that code directly into our apps as well through submodules because it was causing issues with the elm-debugger installing it through elm-package.
So in our apps we include our internal package which has an AutoComplete module that uses elm-menu.
The internal package compiles because in all of our apps we include both our internal package and elm-menu through submodules and we put those directories from the submodules/ folder in our source-directories
list in elm.json
but when we try to generate the docs, there is no way to have a src-directories
option in the elm.json
of the package to tell it to import Menu from submodules/elm-menu/src
so we get a compile error when generating the docs.
from elm-doc-preview.
I see, however this is a constraint of elm make
with packages, not specific to elm-doc-preview
. So I won't be able to do anything about it in elm-doc-preview
.
Anyway, here are two ideas to solve your issue:
- if your forked
elm-menu
kept exactly the same API (with some implementation changes) as the official one, then you can build yourauto-complete
package documentation with the officialelm-menu
as a dependency, because when applications are compiled, they will rebuild the package anyway without using itselm.json
(the package is just an additional source directory of the app). - If 1 is not possible and if you never use the forked
elm-menu
alone without you internalauto-complete
, you could merge the two in a single submodule. So theauto-complete
module will be able to compile in standalone.
from elm-doc-preview.
elm-doc-preview
has no way to change elm make
behavior, so I will close this issue.
from elm-doc-preview.
Related Issues (20)
- Add an option to check whether the documentation is correct HOT 2
- Maintain scroll position when hot reloading? HOT 4
- Error: ENOENT: no such file or directory, mkdir ... when building application doc
- The doc server can't find `elm.json` in some folder structures HOT 1
- `npm audit` warns about vulnerabilites HOT 3
- works nicely HOT 3
- Feature request: Generate docs.json, then exit HOT 1
- Add a CLI option to check whether application documentation is correct HOT 5
- Doc server quits with error below after 10-30 seconds. HOT 4
- elm-doc-preview can get confused if multiple files are modified simultaneously HOT 1
- npm complains about peer dependencies HOT 8
- Provide a way to expose all modules in an application HOT 8
- A better default for the application name HOT 3
- Online version should mention that this works also for applications
- elm-doc-preview crashes after 30 seconds HOT 4
- Static site generation HOT 5
- modules not shown HOT 7
- No output seen when doc format is missing/has errors
- Handle documentation for unexposed code
- Configurable binding address with loopback as default
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 elm-doc-preview.