Missing most of the documentation text.

Question

Missing most of the documentation text.

sorenwacker opened this issue 3 years ago · 6 comments

Maybe I need to install sphinxs and other plugins before this works. However, the only thing that gets published is the Readme file, not the sphinx docs.

Answer 1 · 2022-05-25T23:20:22.000Z

I had to install the theme and the right content is uploaded, however, the css is missing.

https://lewisresearchgroup.github.io/ms-mint/

Answer 2 · 2022-05-25T23:27:47.000Z

Does this work together with sphinx-autodocgen ?

Answer 3 · 2022-05-25T23:44:32.000Z

Apparently a .nojekyll file needs to be present in the gh-pages branch. The stylesheets are working now, however, most of the documentation is not generated. Only the headings are visible.

Answer 4 · 2022-05-26T05:02:13.000Z

Apparently a .nojekyll file needs to be present in the gh-pages branch. The stylesheets are working now, however, most of the documentation is not generated. Only the headings are visible.

The v2 action should add .nojekyll files for you. See 6c2b466

Answer 5 · 2022-05-26T05:11:37.000Z

Does this work together with sphinx-autodocgen ?

I think yes, but you should make sure your project is installed:

...
WARNING: autodoc: failed to import module 'visualization.plotly.plotly_tools' from module 'ms_mint'; the following exception was raised:
No module named 'ms_mint'
WARNING: autodoc: failed to import module 'visualization.plotly' from module 'ms_mint'; the following exception was raised:
No module named 'ms_mint'
...

You can:

Install your project by a docs/requirements.txt file (and you should change requirements_path too)
Or import your project in conf.py like this https://github.com/sphinx-notes/any/blob/master/docs/conf.py#L17

Answer 6 · 2022-05-26T16:56:41.000Z

It works! Amazing :-) Thank you for your help!