You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hi,
So far CommonDoc looks great and easy, but for my little project setting up github pages and CI to show the generated html is a bit too much. I'd like to generate a simple README with my doc and extracted docstrings that can be displayed by github. I also like the fact to show everything in the readme and not redirect to another website, when the documentation is small. Is there a way to achieve that ?
It looks like CommonDoc can not output markdown, can it ?
thanks !
The text was updated successfully, but these errors were encountered:
By the way, this library is written for my documentation generator https://40ants.com/doc/ and it does exactly what you want – generates HTML doc + updates README.md. Also, there is a helper to setup GitHub Actions for doing updates automatically.
Hi,
So far CommonDoc looks great and easy, but for my little project setting up github pages and CI to show the generated html is a bit too much. I'd like to generate a simple README with my doc and extracted docstrings that can be displayed by github. I also like the fact to show everything in the readme and not redirect to another website, when the documentation is small. Is there a way to achieve that ?
It looks like CommonDoc can not output markdown, can it ?
thanks !
The text was updated successfully, but these errors were encountered: