Fortran-FOSS-Programmers / ford

Automatically generates FORtran Documentation from comments within the code.
https://forddocs.readthedocs.io
GNU General Public License v3.0
410 stars 134 forks source link

Feature request: Option to turn off certain homepage components #633

Open blaylockbk opened 9 months ago

blaylockbk commented 9 months ago

Thanks for providing FORD. It wasn't hard to convince our team to use it.


Could there be an option to "turn off" some components on the homepage, specifically the jumbotron summary and the author description. I would like to still include the options like author and project_url to preserve metadata, but I don't need the buttons to show in the jumbotron area.

image

I know I can turn off some of these elements by not including them in the project file options, like author details. However, if you don't include author and author_description, then the copyright footer doesn't make sense..."Fortran Program was developed by" (by who?). (Maybe there is a way to customize the footer text I don't know about).

image image

Also, if I don't include summary and related options, the jumbotron is still rendered adding unnecessary clutter. image




Perhaps options display_jumbotron: false and display_author: false could control these elements.

Thanks for your consideration.

ZedThree commented 7 months ago

Thanks for your suggestions and bug reports @blaylockbk. To be honest, I would prefer not to start adding too many options to control individual elements, and instead add some mechanism to provide custom templates -- this has been on the wishlist for some time I'm afraid! In fact, ideally, I'd love to port most of Ford over to Sphinx and give users a lot more control over how the docs look, but this is a fair bit of work.

In the meantime, I have fixed the empty jumbotron and odd footer.

d7919 commented 5 days ago

PR #672 adds the ability to provide custom templates. It puts the onus on the users to control this rather than exposing element-wise customisation through FORD, but that is probably reasonable.