Building user documentation locally

[capsulecorplab]

Hello fprime-community,
I'd like to build the fprime user documentation, as to be able to add it to the fprime-workspace-image virtual environment I've been working on. If someone could point me to what doc tools I need and how to locally run the user docs build, that'd be much appreciated :)

[thomas-bc]

@capsulecorplab nice!

This is the workflow that build our docs: https://github.com/nasa/fprime/blob/devel/.github/workflows/autodocs.yml

So the main script you'll want to look at is https://github.com/nasa/fprime/blob/devel/docs/doxygen/generate_docs.bash

Let me know if you have any other questions!

[LeStarch]

About all the information I can give you is that we use the "docs" folder as our source. (We technically build off an auto-documentation branch too, but I doubt that would make a difference).

[capsulecorplab]

So, I managed to install jekyll to run a build of the docs, but it looks like it's not quite rendering properly. Any idea as to what I'm doing wrong?
Here's the line in my ansible playbook where I'm running the jekyll build https://github.com/capsulecorplab/fprime-workspace-image/blob/52aff00fee18933e301d1bcebe39cc5de3399415/playbook.yaml#L332

[thomas-bc]

Is it picking up the correct theme? Not sure what all the Your awesome title things are doing there, and the lack of formatting/images/colors etc... kind of makes me wonder if it may have picked up the wrong theme, or no theme at all. But again, we let GitHub Pages do everything for us so we're not the best resource to answer these questions. Maybe the jekyll folks?

The theme is configured in this file: https://github.com/nasa/fprime/blob/devel/docs/_config.yml

[capsulecorplab]

I haven't had time learn Jekyll themes yet, but created a (draft) PR in case anyone in the community would like a preview fprime-community/fprime-workspace-image#35

[capsulecorplab]

I've made another pass at attempting to install the fprime jekyll theme with no luck, but I also noticed the link to the tutorials don't work. Closing my PR for now, as it appears the fprime/docs codebase would need to undergo refactoring in order to support a local build of the documentation.