search

ri0t / asyncapi-sphinx-template

Sphinx rST template for the AsyncAPI Generator
0 stars 1 forks source link

Wrong package name #1

Open fmvilas opened 4 years ago

fmvilas commented 4 years ago

Hey @ri0t!

Great stuff with the Sphinx template, love it! I noticed there's a mistake in README.md. It says:

ag asyncapi.yaml @asyncapi/sphinx-template -o output

This template is not really published on npm under the @asyncapi scope so this command would fail. I couldn't find it on npm. Did you forget to do it maybe?

github-actions[bot] commented 4 years ago

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

ri0t commented 4 years ago

Well, to allow folks to check it out first, i pushed it to my own github account first. If no one complains otherwise, i'd probably be able to publish it to @asyncapi (if it is wanted there, of course) as well as npm.com

derberg commented 4 years ago

@ri0t I create a PR for you with a command that should work for you until you get to NPM

I also tried the resulting output with http://rst.ninjs.org/# and getting many errors (btw, my knowledge about rST = I know it exists 😄 )

ri0t commented 4 years ago

@derberg - Thank you! Though, I already have everything running as expected - i use the local repository for development and would prefer it to be published as soon as possible.

The linter and generator are both already integrated in my tooling - and it renders beautifully with sphinx! - but i'd prefer to publish the generating scripts with the final package locations.