Using nbdev for documentation only, does it make sense?

nbdev
1

Hello All,
I really love to work with nbdev, especially the tight integration of code and documentation and the fact that everything can be automated in a CI-workflow.

But I also have to maintain and develop existing python packages and I was wondering, if it would make sense to use nbdev to write the documentation?

Or just use Quarto? I don’t know. Is it a bad idea? What do you think, is there maybe anyone who has done this already?

2

I’m not very experienced with nbdev, so perhaps others with more experience can provide better input. If I’m understanding your use case correctly—they do have an example on the nbdev page for documentation-only sites. They also walkthrough deploying documentation using GitHub Actions.

3

thanks! I must have overlooked this

1 Like