search

SMAT-Lab / Scalpel

Scalpel: The Python Static Analysis Framework
Apache License 2.0
286 stars 43 forks source link

Readthedocs setup #78

Closed tristanlatr closed 2 years ago

tristanlatr commented 2 years ago

Hi, here is the guide you need to follow to publish the Sphinx docs: https://docs.readthedocs.io/en/stable/tutorial/

EDIT: Just installing the webhook should be enough, I'll take care of the rest.

then the link in the readme needs to be adjusted.

tristanlatr commented 2 years ago

I've created https://readthedocs.org/dashboard/python-scalpel, please create an account on readthedocs.org and give me your username such that I can add you as admins of the project. I'll send you the webhook URL and installation tutorial by email. This is the only step you have to do, I'll create a PR to add a .readthedocs.yaml file and link to the readthedocs page from the README. Then everything should work.

tristanlatr commented 2 years ago

@Jarvx, I just invited you to the readthedocs project. Please proceed with the webhook setup as per the instructions in my email.

Jarvx commented 2 years ago

@tristanlatr Thanks for your instructions in the email. Now the webhook has been created

Jarvx commented 2 years ago

I now close this issue but will give regular attention to the readdocs work. Thanks for the great help!