esdoc / esdoc-hosting Goto Github PK

I would like to be able to:

• Lint my documentation
• Generate documentation from my code

Without hosting it. Just a textarea where I can paste my code and lint it and generate documentation for it.

I prefer that configuration files all have a dot prefix''and ESDoc hosting is looking for esdoc.json

Could you add an exception for .esdoc.json as well? Or better, add a field that lets the user say what their configuration file is called during the hosting generation step?

Hi, thanks for providing this service :)

Our documentation used to generate fine, but now no longer works. Link is [email protected]:sajari/sajari-sdk-js.git.

I've update esdoc config to be named .esdoc.json and added the standard plugin. When running locally everything works.

The package.json dependencies does not include esdoc, could that be what's causing the online generator to fail?

ESDoc works locally but fails with the public generator

Generate function fails on the hosting site. The repository contains ES6 code. esdoc.json is located in the root folder. Esdoc v1.04 works locally.

After regenerating the documentation, the coverage badge is not updated on GitHub. If I understand correctly, this can be solved by adding a Cache-Control: no-cache header to the response according to this issue: github/markup#224

Thanks!

It would be great if docs could be generated and updated automatically each time a repo's master branch is updated, a little like how readthedocs works.

If I paste the repository URL into the text field on the generation page and click the Generate button, I see no change on the page. If I open Developer Tools, there is a JavaScript error on the console:

ReferenceError: Can't find variable: ESDoc - generate.html:81

Generation works perfectly in Chrome on the same OS.

Generating the esdoc for the repository [email protected]:Scalingo/scalingo.js.git fails when its triggered via the online hosting service page -> -> https://doc.esdoc.org/-/generate.html fails always. Same thing with esdoc-uploader

In the local working copy the generation of the esdoc works fine.

I hope ESDoc's web hosting service will also support plugins.

I use esdoc-node to parse require/export of Node with ESDoc.

{
  "source": "./src",
  "destination": "./esdoc",
  "test": {
    "type": "mocha",
    "source": "./test"
  },
  "plugins": [
    { "name": "esdoc-node" }
  ]
}

It works locally, but it seems that the plugin is ignored if it is web hosting.
For example, this is output when esdoc-node is not running.

unable to create doc it's just saying
Please retry

I'm able to generate fine locally - not hosted.

Problem Statement

1. What were you trying to do?
   Generate esdoc hosted pages

To do this I used https://doc.esdoc.org/-/generate.html

and entered

[email protected]:drpaulbrewer/single-market-robot-simulator-app-framework.git

in the box provided and clicked generate.

2. What happened?

Error message on the website

Fail esdoc. Please check esdoc.json. Or write issue.

Stack trace in browser console

generate.html:133 Fail esdoc. Please check esdoc.json.
(anonymous) @ generate.html:133
xhr.onload @ ESDoc.js:44

3. What did you expect it to do instead?

Generate esdoc and host it, sending me a URL.

4. Anything else?

my browser's about:

Chromium	56.0.2924.76 (Developer Build) Built on Ubuntu , running on Ubuntu 16.04 (64-bit)
Revision	314da7cc1e56fc9fa9271bac2b029922feb4b6f2
OS	Linux 
JavaScript	V8 5.6.326.42
Flash	(Disabled)
User Agent	Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Ubuntu Chromium/56.0.2924.76 Chrome/56.0.2924.76 Safari/537.36
Command Line	/usr/lib/chromium-browser/chromium-browser --enable-pinch --flag-switches-begin --flag-switches-end
Executable Path	/usr/lib/chromium-browser/chromium-browser
Profile Path	/home/paul/.config/chromium/Default

Also esdoc works fine locally on this package:

esdoc 0.5.2

paul@home:/Z/Projects/single-market-robot-simulator-app-framework$ esdoc -c esdoc.json 
badge.svg
identifiers.html
index.html
class/src/index.js~App.html
function/index.html
file/src/index.js.html
./css
./script
./image
script/search_index.js
source.html
==================================
Coverage: 65.3% (32/49)
==================================

Documentation seems to generate fine when run with the command line tool but isn't working with the hosted tool: [email protected]:vincentriemer/animar.git

Thanks

Hi, one of my repos potassium-es generates locally and on esdocs with no problems but the other, potassium-components generates locally but fails on esdocs.

As far as I can tell, there are no warning messages or other helpful output when I run it locally, but I'm happy to debug it on this side if you have suggestions.

Hi there,

I have a question regarding the hosting of esdoc hosting: have you got a plan to make this project freely available for open source projects after the beta phase?
I'd like to use the future github hook you seem working on to automate the publishing of esdoc, but I'd like to have better understanding of your goals.

Cheers,

Local generate ok, but host failed.

Repo is https://github.com/grizzly-atoms/brainspan
Docs are here: https://doc.esdoc.org/github.com/grizzly-atoms/brainspan/

...by entering their Git repo address here: https://doc.esdoc.org/-/generate.html and pressing "Delete".

LOL

[email protected]:Reading-eScience-Centre/covjson-reader.git

The docs are just not updated even though it said "success!"

Fail esdoc. Please check esdoc.json.

esdoc.json

{
    "source": "./src",
    "destination": "./docs",
    "plugins": [
        {
            "name": "esdoc-standard-plugin"
        }
    ]
}

Greets,

As described in this issue (esdoc/esdoc#135) I've created a plugin to link together many JSPM (www.jspm.io) managed modules / repos to create end to end documentation with ESDoc. Presently the ESDoc hosting solution runs against a single source root. To make things even worse in regard to SystemJS / JSPM is that the dependent repos managed by JSPM are not checked into any given target repo. IE they are installed by "jspm install" (similar to npm install) after checking out the repo.

Given this constraint the ESDoc hosting service is not aware of JSPM / package management and can only generate documentation for one source root. The easiest way to resolve this situation is to generate documentation from the target repo and all managed repos via JSPM and simply check it into the target repo.

Providing an entry in "esdoc.json" it would be great to inform the ESDoc hosting service to pull the generated docs from the repo and not attempt to auto-generate them directly from the repo as a more involved build process might prevent complete ESDoc generation.

Cheers...

I'd like to use this service, is it still running? I notice there haven't been any commits since 2018 and the build is failing.

Attempting to run the generator shows gives a 500 bad gateway error.

Generating the esdoc for the repository [email protected]:js-joda/js-joda.git fails when its triggered via the online hosting service page -> -> https://doc.esdoc.org/-/generate.html fails always.

In the local working copy the generation of the esdoc works fine.

is that a timeout issue because the documentation is to large ?

I understand how supporting arbitrary plugins might be a security issue, however esdoc-flow-plugin would be nice to add as currently my project fails to build due to having syntax errors on flow types.

self-hosting documentation fails without a clear error message for my repository :
[email protected]:nickooms/world-builder.git

It'd be nice to be able to specify a branch, e.g.
[email protected]:foo/bar.git#mybranch

But the generate page treats this as an error.
'This is invalid git url. Valid format is "[email protected]:foo/bar.git"'

Generate function fails on the hosting site. The repository contains ES6 code. esdoc.json is located in the root folder. Esdoc v1.04 works locally.