Integrate pydoc-markdown

[maoo]

The website gets correctly generated into the gh-pages branch, reading MarkDown files from the docs folder (and configuration in website/siteConfig.js.

In order to also publish code docs, we could use https://pypi.org/project/pydoc-markdown/ , specifically the pydocmd simple command.

I played a bit with it but couldn't generate contents. @grovesy , maybe you could give this a try?

[mcleo-d]

I've added this issue to To Do the DataHub Project Kanban.

[zheyu-wang-tony]

Hi @maoo, how can we preview the doc website when our repo is private?

[maoo]

Good point! You can test it locally, check docs on https://github.com/finos/datahub/blob/master/website/

[zheyu-wang-tony]

@maoo , I've enabled pydocmd along with docusaurus. Probably we can close this issue.

[finos-admin]

Awesome work @zheyu-wang-tony !

I see that you adde the pydocmd logic and the action runs successfully, well done!

I still cannot run it locally though, although I'm trying to use python3 and I'm following the steps described in build.yml.

Would it be possible for you to document the steps into https://github.com/finos/datahub/tree/master/website/README.md , so that contributors will be able to easily run the website locally?

TY!

[zheyu-wang-tony]

@finos-admin https://github.com/finos/datahub/blob/master/website/README.md#integrate-with-pydocmd Does this work for you?

[maoo]

Yes, it works now!

I had problems due to the fact that python was still using version 2, therefore pydocmd command failed; to avoid this, I proposed a PR to:

• use python instead of python3
• add a requirement that python --version returns version 3.7.x

WDYT? If you like it, feel free to merge and close this issue. TY!

[zheyu-wang-tony]

Task completed.