Code documentation #1611

New Issue

OVERLORD · 2026-02-05T01:25:26+03:00

OVERLORD commented

2026-02-05 01:25:26 +03:00

Originally created by @alvaropc on GitHub (Mar 26, 2020).

Describe the feature you'd like
Hi! I was looking for a way to add code documentation to BookStack but it does not seem to be possible right now.

Since I am writing a project documentation book it would be nice to add there code documentation too.

In my case I use Python and Sphinx to create the code documentation, the final result is a html page.

I really do not know how but adding this kind of documentation would be very useful!

Describe the benefits this feature would bring to BookStack users
Users could have project and code documentation in the same place and won't need another instances to put their code documentation.
Having all together would be really comfortable to anyone reading the documentation.

In this issue I am assuming there is not possible to do so in any way, but if there is some kind of workaround I would love to know about it!

Thank you so much!

Originally created by @alvaropc on GitHub (Mar 26, 2020). **Describe the feature you'd like** Hi! I was looking for a way to add code documentation to BookStack but it does not seem to be possible right now. Since I am writing a project documentation book it would be nice to add there code documentation too. In my case I use Python and Sphinx to create the code documentation, the final result is a html page. I really do not know how but adding this kind of documentation would be very useful! **Describe the benefits this feature would bring to BookStack users** Users could have project and code documentation in the same place and won't need another instances to put their code documentation. Having all together would be really comfortable to anyone reading the documentation. In this issue I am assuming there is not possible to do so in any way, but if there is some kind of workaround I would love to know about it! Thank you so much!

OVERLORD added the 🌔 Out of scope label 2026-02-05 01:25:26 +03:00

OVERLORD closed this issue

2026-02-05 01:25:28 +03:00

OVERLORD commented

2026-02-05 01:25:31 +03:00

@homotechsual commented on GitHub (Mar 26, 2020):

Generate your code documentation into Markdown format - you can then input this into Bookstack using the Markdown editor (and probably eventually using the API when this is fully developed!)

https://stackoverflow.com/questions/13396856/markdown-output-for-sphinx-based-documentation

https://github.com/codejamninja/sphinx-markdown-builder/

@homotechsual commented on GitHub (Mar 26, 2020): Generate your code documentation into Markdown format - you can then input this into Bookstack using the Markdown editor (and probably eventually using the API when this is fully developed!) https://stackoverflow.com/questions/13396856/markdown-output-for-sphinx-based-documentation https://github.com/codejamninja/sphinx-markdown-builder/

OVERLORD commented

2026-02-05 01:25:35 +03:00

@alvaropc commented on GitHub (Mar 26, 2020):

Oh! I did not know about the sphinx markdown builder, I will give it a try!

Thank you so much!

@alvaropc commented on GitHub (Mar 26, 2020): Oh! I did not know about the sphinx markdown builder, I will give it a try! Thank you so much!

OVERLORD commented

2026-02-05 01:25:38 +03:00

@ssddanbrown commented on GitHub (Apr 1, 2020):

Hi @alvaropc,

BookStack has support for inserting code blocks via both the Markdown and WYSIWYG editor, If you had not found that just let us know and we can point it out.

Upon those basic editor features, I don't really want to go down the road of including code/developer/api focused features within the core BookStack project. This comment expresses my reasoning for this:
https://github.com/BookStackApp/BookStack/issues/1759#issuecomment-554514238
It's referencing API documentation but that same applies to code/developer specific documentation.

Otherwise, a custom scripted solution as suggested by @MikeyMJCO may suit you best.

Therefore I'm going to close this off as out-of-scope.

@ssddanbrown commented on GitHub (Apr 1, 2020): Hi @alvaropc, BookStack has support for inserting code blocks via both the Markdown and WYSIWYG editor, If you had not found that just let us know and we can point it out. Upon those basic editor features, I don't really want to go down the road of including code/developer/api focused features within the core BookStack project. This comment expresses my reasoning for this: https://github.com/BookStackApp/BookStack/issues/1759#issuecomment-554514238 It's referencing API documentation but that same applies to code/developer specific documentation. Otherwise, a custom scripted solution as suggested by @MikeyMJCO may suit you best. Therefore I'm going to close this off as out-of-scope.

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#1611