Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
blaylockbk opened this issue Feb 29, 2024 · 2 comments
Open

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

blaylockbk opened this issue Feb 29, 2024 · 2 comments

Comments

@blaylockbk
Copy link
Contributor

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
Copy link
Member

ZedThree commented Apr 3, 2024

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
Copy link
Contributor

d7919 commented Nov 20, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants