search

zincware / MDSuite

A post-processing engine for particle simulations
https://mdsuite.readthedocs.io/
Eclipse Public License 2.0
36 stars 7 forks source link

Docs won't build #101

Closed SamTov closed 3 years ago

SamTov commented 3 years ago

Describe the bug A clear and concise description of what the bug is.

To Reproduce Steps to reproduce the behavior: run make html from docs directory

Expected behavior Should build documentation

Screenshots

File "/tikhome/stovey/.local/lib/python3.8/site-packages/sphinxcontrib/bibtex/foot_roles.py", line 63, in result_nodes formatted_entry = style.format_entry(label='', entry=entry) AttributeError: 'Style' object has no attribute 'format_entry'

Desktop (please complete the following information): Ubuntu 18

Additional context If you set footcite to cite you can remove this error but then you will get another bib error afterwards so something is wrong with the citation managment.

Fratorhe commented 3 years ago

Try pip installing these packages: 'sphinx.ext.autosectionlabel' 'sphinxcontrib.bibtex'

I added them to allow these footnotes.

We should make sure that the extensions used in docs/conf.py line 29 are added in the requirements.py

SamTov commented 3 years ago

had to upgrade pybtex

pip install --upgrade pybtex

It now compiles.

KaiSzuttor commented 3 years ago

what about continious delivery? 😁

SamTov commented 3 years ago

I think when the code is public we will have to do this right... It is already linked with readthedocs and so docs should build automatically but currently we have no tests or anything in place which will probably become important