Restore author list to Tutorial, fix up the bibliography #4573
Conversation
Copied from Doc/Tutorial.tex as of v1.82 prior to the LaTeX to RST conversion. (This seems a better placement than in the copyright footer as per the theme.)
My ad hoc LaTeX BibItem to RST script didn't cope with the accents.
|
I've worked out why the [Kent2002] and [Matys2003] entries show with extra indentation: https://biopython.org/docs/dev/Tutorial/chapter_bibliography.html They start with an initial dot space. Now how to fix this... Update See https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#enumerated-lists - could split the line, or escape the letter or the dot. |
This stops the line being treated as a single entry alphabetically enumerated list. See https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#enumerated-lists i.e. Fixed the unwanted indentation.
Was pointing at the correction DOI for adding two missing references.
|
@mdehoon your eyes on this might be helpful, particularly is the current capitalisation of "de Hoon" OK? (Under LaTeX all the bibliography keys were lower case but not user facing; now they are user facing and I picked |
This appears to avoid a subtle bug in Sphinx generating invalid LaTeX with symbol footnotes. Automatically numbered footnotes are fine though. Tested on macOS using: Sphinx==4.3.2 sphinx-rtd-theme==1.3.0 and: $ make latexpdf
This works, is readable, but not as pretty as I'd like. We might use the maketitle setting to setup the entire PDF title page ourselves? Note that as far as I can see, the author field has no effect on the HTML output, thus we now have a duplicated author listing in the index.rst file, which is not ideal.
|
Good news: PDF output is looking much better now, although I'd like the title page to look nicer. This includes the author list. Bad news: There is no equivalent title page in the HTML output. So, by inserting the author list explicitly (currently above the Tutorial table of contents), it appears once in the HTML and twice in the PDF. And we have to keep the two in sync. That will have to do in the short term. |
These didn't render nicely in the HTML, and to me added nothing over the HTML output's TOC. Seems to have no effect on the PDF output (which still has indices which look much better).
Thanks @peterjc , this always confuses everybody. |
Quoting feedback on the pull request: In Dutch, capitalization depends on the grammatical context. Specifically, the letter appearing first in the name should be capitalized. So it is "Mr. Van Gogh" but "Mr. Vincent van Gogh". Then I guess "DeHoon2004" makes more sense, but either way is fine.
I hereby agree to dual licence this and any previous contributions under both
the Biopython License Agreement AND the BSD 3-Clause License.
I have read the
CONTRIBUTING.rstfile, have runpre-commitlocally, and understand that continuous integration checks will be used to
confirm the Biopython unit tests and style checks pass with these changes.
I have added my name to the alphabetical contributors listings in the files
NEWS.rstandCONTRIB.rstas part of this pull request, am listedalready, or do not wish to be listed. (This acknowledgement is optional.)
CC @idoerg