search

ponnhide / pyCircos

python Circos
GNU General Public License v3.0
334 stars 66 forks source link

Fix API Documents workflow #18

Closed moshi4 closed 2 years ago

moshi4 commented 2 years ago

There was a small error in the workflow for PR (#17). It looks like the documentation generation to the gh-pages branch is failing because of it.

Sorry for the trouble. Please merge the corrected version.

ponnhide commented 2 years ago

Thank you for your cooperation. I was just about to ask you about the issue. And I'm sorry that the branch name is still "master", I will change the name.

ponnhide commented 2 years ago

Now, I was able to publish the Github pages of pyCircos.
Actually, I am an amateur OSS developer so I will learn more. Thank you for your grateful cooperation.

moshi4 commented 2 years ago

It looks like you have correctly published the API documentation for pycircos. I would recommend putting a link to the API documentation in the README, as I think it will help users understand pycircos.

Currently, when you update a docstring in the code on the master branch, the API documentation is set to automatically update as well, which I think will ease some of the burden of maintaining the API documentation.