search

prithviulm / qudi-core

A framework for modular measurement applications.
https://qudi-core-testing.readthedocs.io/en/latest/
GNU General Public License v3.0
0 stars 2 forks source link

The existing documentation is incompatible with Sphinx [Bug] #5

Open prithviulm opened 6 months ago

prithviulm commented 6 months ago

Version

Development

What is affected by the bug?

The docstrings will not render properly on RTD using Sphinx.

When does the bug occur?

When building the docs.

How do we replicate the issue?

Build the docs locally or on RTD.

Expected behavior

Should not be getting yelled at endlessly for syntax errors relating to dostring formatting/ pointing nowhere/ unknown syntax/ whatever else.

Relevant log output

No response

Additional Comments

It is going to be an incredible journey trying to standardise the existing docstrings because they are all written differently. It might be possible to automate this task either using copilot or otherwise.

No response

Contact Details

No response

prithviulm commented 2 weeks ago

HiWi has worked on this. Need to check the autogenerated and compiled html files for remnants of the old docstrings.