peeringdb / peeringdb

Server code for https://www.peeringdb.com/
BSD 2-Clause "Simplified" License
340 stars 111 forks source link

Dev module docs auto generation broken #1593

Open vegu opened 1 month ago

vegu commented 1 month ago

Describe the bug The script to generate the files at https://github.com/peeringdb/peeringdb/tree/master/docs/dev/modules currently fails with the following error.

I believe this is due to pymdgen not supporting py3.11.

Traceback (most recent call last):
  File "/srv/www.peeringdb.com/peeringdb_server/gendocs.py", line 23, in <module>
    doc_text = doc_module(f"peeringdb_server/{entry.name}", section_level=1)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/srv/www.peeringdb.com/venv/lib/python3.11/site-packages/pymdgen/__init__.py", line 336, in doc_module
    out_functions.extend(doc_func(k, v, section_level + 1))
                         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/srv/www.peeringdb.com/venv/lib/python3.11/site-packages/pymdgen/__init__.py", line 64, in doc_func
    spec = getargspec(func)
           ^^^^^^^^^^^^^^^^
  File "/srv/www.peeringdb.com/venv/lib/python3.11/site-packages/pymdgen/__init__.py", line 40, in getargspec
    return inspect.getargspec(func)
           ^^^^^^^^^^^^^^^^^^
AttributeError: module 'inspect' has no attribute 'getargspec'. Did you mean: 'getargs'?

To Reproduce Run python peeringdb_server/gendocs.py inside the container.

Who is affected Python module documentation will be out of date until fixed, this affects developers working on peeringdb.