-
Notifications
You must be signed in to change notification settings - Fork 9
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
Documentation links in tutorials #136
Conversation
Maybe use local referencing? That way it'd be possible to view the links even if they are not on github. Instead of
use
|
Also, would it be possible to create a function that, like
and it would be replaced with
EDIT: This would allow us to specify to which dependencies are required for each tutorial or to omit the installation cell:
will generate an installation cell with And if there is no such string, the installation cell will not be present in the file. |
We add template for macros in another PR, now fix linking |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the doc building successfully for you?
For me, the first cell is not building
I am able to fix that by removing # noqa: E501
from the cells.
Obviously, that will fail our linter.
One possible solution would be to reformat the way we insert links:
instead of
Here, [PollingTelegramInterface](https://deeppavlov.github.io/dialog_flow_framework/apiref/dff.messengers.common.interface.html#dff.messengers.common.interface.PollingMessengerInterface)
class and [telebot](https://pytba.readthedocs.io/en/latest/index.html) library are used for accessing telegram API in polling mode.
use
Here, [PollingTelegramInterface](
../apiref/dff.messengers.common.interface.html#dff.messengers.common.interface.PollingMessengerInterface
) class and [telebot](
https://pytba.readthedocs.io/en/latest/index.html
) library are used for accessing telegram API in polling mode.
Unfortunately, that is still 105 characters.
Seems like the easiest solution is to wait for an implementation of the aforementioned tutorial patterns.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Waiting for #144 |
Description
Added some documentation links to some of the tutorials.
Checklist