Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Config Generation #2145

Closed
sils opened this issue May 14, 2016 · 6 comments
Closed

Document Config Generation #2145

sils opened this issue May 14, 2016 · 6 comments

Comments

@sils
Copy link
Member

sils commented May 14, 2016

No description provided.

@gitmate-bot
Copy link
Collaborator

Thanks for reporting this issue!

Your aid is required, fellow coalaian. Help us triage and solving this issue!

CC @sils1297, @AbdealiJK

@sils
Copy link
Member Author

sils commented May 14, 2016

for linter

@AbdealiLoKo
Copy link
Contributor

I think the best way is to make a website which has a table of the configs being used right now, the documentation related to that param, and the bears it's being used in. This website/webpage should have a search box for easy searching and should be auto generated from the bears itself.
This webpage would help third party bear writers too ! And would be a really cool one-page documentation of all the "features" coala provides. And also which bears it provides them in.

Possible methods of doing this:

  • Make a parser using our documentation parsing routines and create a webpage with it. And then link this in the docs.
  • Configure sphinx to autogenerate this (somehow? if it's possible...) I think sphinx is pretty flexible ?

I think this page should reside in our documentation and should be "autogenerated" in every readthedocs build.

@sils
Copy link
Member Author

sils commented May 30, 2016

@AbdealiJK are you sure this comment was on the right issue? Did you mean to comment on coala/coala-bears#460 ?

@AbdealiLoKo
Copy link
Contributor

Yes indeed. I confused the issues.
It was meant for coala/coala-bears#460

@Adrianzatreanu
Copy link
Contributor

This issue was moved to coala/documentation#42

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

4 participants