search

assume-framework / assume

ASSUME - Agent-based Simulation for Studying and Understanding Market Evolution
https://assume.readthedocs.io
22 stars 5 forks source link

Documentation build fails because of the CLI command documentation #392

Closed nick-harder closed 1 month ago

nick-harder commented 1 month ago

Something inside command_line_interface.rst is causing the documentation build to fail. I believe it has something to do with the file path. 

.. argparse::
   :filename: ../assume_cli/cli.py

if I remove the ../ and run the sphinx build sphinx-build -b html docs/source docs/build everyhting works, but the make -C docs html && python -m http.server --directory docs/build/html fails. I cannot figure out how to properly fix this. @maurerle do you have a suggestion?

nick-harder commented 1 month ago

I made a fix suggestion in the connected PR, please take a look at it

nick-harder commented 1 month ago

@maurerle unfortunately the previous fix didn't solve the problem, the docs were still failing. I have spent two hours trying to figure out how to fix it, but didn't suceed. In a connected PR I have removed the CLI documentation so we can build the docs. Please fix the error if you have time, or merge the commit removing the CLI documentation for now if you don't have currently time to fix it