moja-global / moja_global_docs

Repository to host the moja global technical documentation

https://docs.moja.global/en/master/

Mozilla Public License 2.0

35 stars 69 forks source link

DOCS: Host python notebooks containing different data-types #162

Closed padmajabhol closed 2 years ago

padmajabhol commented 2 years ago

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

[x] Issue reference #160
[x] Subject Matter Expert (SME) reviewer: @aornugent
[x] Peer reviewer: @HarshCasper @chicken-biryani
[ ] Preview Links:
[x] Explain the changes: The python notebooks containing the datatypes(used as FLINT inputs) have been hosted in the sphinx site.
[x] Dependency changes: I have used the nbsphinx extension to render the notebooks in sphinx.

Thanks for opening the Pull Request for moja global. Happy contributing ✨

shloka-gupta commented 2 years ago

Hi @padmajabhol do you think it's a good idea to specify which file you're using as an example here, if not specified already?

A new reader may get confused.

padmajabhol commented 2 years ago

Hi @padmajabhol do you think it's a good idea to specify which file you're using as an example here, if not specified already?

A new reader may get confused.

I have mentioned the data types. I'll add the file name with the link.

aornugent commented 2 years ago

@HarshCasper - it seems publishing notebooks requires Pandoc in the CI environment:

https://github.com/moja-global/moja_global_docs/runs/5679134773?check_suite_focus=true#step:4:227

saranda-2811 commented 2 years ago

According to line 122 of the logs, nbconvert 6.4.5 has requirement MarkupSafe>=2.0, but you'll have markupsafe 1.1.1 which is incompatible. @padmajabhol Could u update the requirements.txt to markupsafe with version>=2.0 and check?

https://github.com/moja-global/moja_global_docs/runs/5887538966?check_suite_focus=true