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

Linter_Bears.rst: Link to API docs #2614

Closed
SanketDG opened this issue Aug 15, 2016 · 5 comments
Closed

Linter_Bears.rst: Link to API docs #2614

SanketDG opened this issue Aug 15, 2016 · 5 comments

Comments

@SanketDG
Copy link
Member

No description provided.

@swrj
Copy link

swrj commented Aug 17, 2016

Could you clarify what is needed to be done?

@SanketDG
Copy link
Member Author

SanketDG commented Aug 17, 2016

@swrj sure!

So in Linter_Bears.rst, there is this piece of text:

If you need more information about the @linter decorator, refer to the API
documentation. It's more versatile than described in this little tutorial.

The task is to link the text "API documentation" to our api docs http://coala.readthedocs.io/en/latest/API/modules.html

Let us know if you'd like to work on this.

@Makman2
Copy link
Member

Makman2 commented Aug 17, 2016

@SanketDG do we have the possibility to use some "relative" link, so we don't need to link hardcodedly to our website?

@SanketDG
Copy link
Member Author

SanketDG commented Aug 17, 2016

Yes we can by using the :doc: thing I think

:doc:`API documentation <API/modules>`

@Adrianzatreanu
Copy link
Contributor

This issue was moved to coala/documentation#21

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