Add an author to pages

[choldgraf]

Many publishing platforms allow you to specify an author for a page that will be inserted somewhere (usually under the title). Jupyter Book could allow for author metadata for each page (or for a book?) that would be inserted onto the page somewhere.

Implementation

This would be a little bit trickier in Sphinx because the title is usually embedded within the doctree, but we could add an author node underneath the title if an author: <author-name> metadata field is discovered.

[jstac]

I discussed this with @mmcky and I think he's working on it / thought about it.

[mmcky]

certainly on the todo list -- local author

Perhaps it would be added underneath the overall authors that are defined in _config.yml. A mockup of two options is below.

[prappleizer]

Hi, I'm working on something that would really benefit from this and was wondering if anything currently exists since 2020 to allow it? (or if there is a workaround)?

[choldgraf]

@prappleizer we're working on a new document engine for Jupyter Book, which you can check out here:

https://mystmd.org

You can use the MyST engine on its own without Jupyter Book for now if you like, and when Jupyter Book 2.0 is release it will use MyST under the hood.

MyST already supports author information in pages and books, want to try that out?

https://mystmd.org/guide/frontmatter#frontmatter-authors

[prappleizer]

Hi Chris, thanks for the quick response! I have used both jupyter book and mystmd’s engine pretty extensively and am aware of mystmd’s ability to add the author metadata easily to pages.

I would prefer to use jupyter book, for my current scenario, for a few reasons. First, it has a built in search bar / indexing, which is critical for my project. Second, I am creating a lot of custom pages and directives (like automatic galleries of content and custom admonition blocks) where I need fine tuned control. So far the extensibility to add sphinx directives have really facilitated this and I’m more experienced with python than JS so I’m both not sure how easily mystmd can be wholly extended/customized and am also not sure how long it would take me to learn how to do so.

Basically at the current time it seems I will have to hack either framework to get all the features I need, so I’m happy to take advice on which is easier to hack and modify.

On Tue, Jul 23, 2024 at 12:28 PM Chris Holdgraf @.***> wrote:

@prappleizer https://github.com/prappleizer we're working on a new document engine for Jupyter Book, which you can check out here:

https://mystmd.org

You can use the MyST engine on its own without Jupyter Book for now if you like, and when Jupyter Book 2.0 is release it will use MyST under the hood.

MyST already supports author information in pages and books, want to try that out?

— Reply to this email directly, view it on GitHub https://github.com/jupyter-book/jupyter-book/issues/1098#issuecomment-2245700497, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACD6XXAWJK6VPLSLIR5KOFLZN2AD7AVCNFSM6AAAAABLKWI6NCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDENBVG4YDANBZG4 . You are receiving this because you were mentioned.Message ID: @.***>

[choldgraf]

My recommendation would be to start signaling the features with MySTMD that you'd really need to switch, because the Sphinx stack with Jupyter Book will likely have much less time invested in it in general. For example, you could ask @rowanc1 how he got Algolia working with the mystmd docs and see if you could replicate that in your site. I'm not sure what you mean about indexing but perhaps that's another feature that needs to be tracked at https://github.com/jupyter-book/mystmd ?

[prappleizer]

Yeah I actually have chatted with him! Unfortunately the timescale on which this project needs to be operational is quite short, and most of the features I am trying to implement were ones that he indicated would have to be paid/funded through curvenote as opposed to the open source side of things (though he said there may be some which could be done on the open source side). I’m certainly happy to vote for features from jupyter book to add to myst, but in the meantime it seems I’m going to have to figure out workarounds.

On Tue, Jul 23, 2024 at 12:56 PM Chris Holdgraf @.***> wrote:

My recommendation would be to start signaling the features with MySTMD that you'd really need to switch, because the Sphinx stack with Jupyter Book will likely have much less time invested in it in general. For example, you could ask @rowanc1 https://github.com/rowanc1 how he got Algolia working with the mystmd docs and see if you could replicate that in your site. I'm not sure what you mean about indexing but perhaps that's another feature that needs to be tracked at https://github.com/jupyter-book/mystmd ?

— Reply to this email directly, view it on GitHub https://github.com/jupyter-book/jupyter-book/issues/1098#issuecomment-2245759884, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACD6XXB2QI4EVMGUG6O4KNDZN2DLRAVCNFSM6AAAAABLKWI6NCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDENBVG42TSOBYGQ . You are receiving this because you were mentioned.Message ID: @.***>