search

PySlurm / pyslurm

Python Interface to Slurm
https://pyslurm.github.io
GNU General Public License v2.0
474 stars 116 forks source link

Mkdocs #271

Closed tazend closed 1 year ago

tazend commented 1 year ago

Based on #268

@multimeric Alright, you should be able to run scripts/builddocs.sh and mkdocs serve to check out the rendered docs from compiling with Cython 3

multimeric commented 1 year ago

Looks good! I've added a PR that enables binding globally, but doing it just for pyslurm.pyx is probably fine too. Also, did you want to use the mkdocs theme? You just have to change the theme name in the config file.

tazend commented 1 year ago

Initially wanted to use the readthedocs theme, but I changed my mind - I think the material theme is a bit nicer and more customizable.

As for the binding: With Cython >= 3 we don't need to configure anything specific, as binding is enabled globally by default in Cython 3.

multimeric commented 1 year ago

Looks good to me. The docstrings should Just Work because you're enforcing Cython 3 in the doc requirements.