Adding author names in title of the main page

[AakashGfude]

Author names from the description need to be removed from individual repos.

fixes #233

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (e65778b) 73.18% compared to head (d81a464) 73.07%.
Report is 3 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #239      +/-   ##
==========================================
- Coverage   73.18%   73.07%   -0.11%     
==========================================
  Files           2        2              
  Lines         261      260       -1     
==========================================
- Hits          191      190       -1     
  Misses         70       70              

Flag	Coverage Δ
pytests	73.07% <100.00%> (-0.11%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[mmcky]

@jstac we are adding the ability to create hyperlinked names as well but let us know what you think of style.

I think:

• some additional padding between title and authors

What do you think about the relative text size?

[AakashGfude]

@mmcky author names with links, i have kept it blue purposefully to indicate its clickable.
https://github.com/QuantEcon/quantecon-book-theme/assets/6542997/d8e53230-30e7-4b9f-834f-46bfb5d46ab1

The config variable for this is:

authors:
        - name: Thomas J. Sargent
          url: http://www.tomsargent.com/
        - name: John Stachurski
          url: https://johnstachurski.net/

[AakashGfude]

Note that this link feature extends to author names displayed in sub-pages as well. But will revert to previous non-clickable titles if the authors config is not provided.

[AakashGfude]

@mmcky have added the feature now to:

1. if number of elements (names) ==2 use and
2. if number of elements (names) > 2 then use name1, name2, and name3
3. and nothing for number of elements (names) < 2

[AakashGfude]

• Added docs

[mmcky]

thanks @AakashGfude -- great work.

[mmcky]

@AakashGfude would we be able to add font size as a parameter in the config then we can adjust if needed.

[mmcky]

@AakashGfude I think the remaining items are:

• check if no author information is provided then the element is not added to the HTML
• add font size passthrough as a config option

Once that edge case is tested and the font size passthrough is set and added to the docs then LGTM. :-)

[AakashGfude]

@AakashGfude I think the remaining items are:

* [ ]  check if no author information is provided then the element is not added to the HTML

@mmcky this should be handled already. If no author dict is provided, then we take the author names from the old author key (But it doesn't have hyperlinks). If even that is not available, then the element should be empty.

Let me know if this is not working. I will test it again too.

[mmcky]

Thanks @AakashGfude that's great.

[AakashGfude]

@mmcky I have created a config for font size. called author_font_size. Looking for name ideas.
Should we just use it for the main toc page. or the rest of the pages as well?
Rest of the page have different header size to front toc page, so the same font size might for authors might not have the same look.

The property has default value of 18px. We can set pixels, by giving a number. FOr example:

html_theme_options:
        author_font_size: 20

would set 20px.

[mmcky]

Should we just use it for the main toc page. or the rest of the pages as well?

I think this should be just for main page as it is likely to be bigger than other pages.
I think the other pages is OK as it is (matching font size to text around it).

I suspect the other pages are using the author information in _config.yml. Is that right? We should add a note to the documentation perhaps.

If yes, maybe the theme author setting should be

mainpage_author
mainpage_author_fontsize

What do you think about that?

thanks @AakashGfude

[AakashGfude]

@mmcky, I made the other pages also use authors with hyperlinks, cause I suspected readers would want that clickable as well? And not having to go to main toc to get the link? What do you think?
The font size one I agree.

[mmcky]

@mmcky, I made the other pages also use authors with hyperlinks, cause I suspected readers would want that clickable as well? And not having to go to main toc to get the link? What do you think?

@AakashGfude -- Roger that. That makes sense and also becomes a single source of truth. So the way it works is if Author is specified in _config.yml then that will get used, but if author is specified in html_theme_options that will take priority?

Let's keep the relationship in font size on the other pages (to the surrounding text) and only allow font size changes for the mainpage. ✅

[mmcky]

Love your work on this @AakashGfude. Thanks.

When you're ready please go ahead and merge and make a new release.

With new features I think you can do a semi-major release 0.7.0

[AakashGfude]

So the way it works is if Author is specified in _config.yml then that will get used, but if author is specified in html_theme_options that will take priority?

That's right @mmcky.

Let's keep the relationship in font size on the other pages (to the surrounding text) and only allow font size changes for the mainpage. ✅

Done!

Great. I will merge and make a release.