Skip to content

Commit 3044ea0

Browse files
authored
Giving up on Sphinx to PDF via LaTeX for releases
Failed for Biopython 1.85, and again today on a fresh LaTeX install for Biopython 1.86
1 parent 0f3c2d2 commit 3044ea0

File tree

1 file changed

+14
-27
lines changed

1 file changed

+14
-27
lines changed

wiki/Building_a_release.md

Lines changed: 14 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,6 @@ Biopython optional dependencies as possible for local testing):
3333
1. Python 3
3434
2. git
3535
3. [twine](https://github.com/pypa/twine/), installed with ``pip install twine``
36-
4. LaTeX, including assorted packages like comments and preprint.
37-
5. [hevea](http://hevea.inria.fr/), I am currently using version 2.32 of 2012-07-04
3836

3937
Final commit(s)
4038
---------------
@@ -108,32 +106,21 @@ Making and testing the tar-ball
108106
drevil:~tmp1/> cd biopython
109107
```
110108

111-
11. make the documentation PDF in Doc (we have automated an HTML version online; will need ``latexmk`` etc installed):
112-
113-
``` bash
114-
drevil:~tmp1/biopython/> pip install -r .circleci/requirements-sphinx.txt
115-
drevil:~tmp1/biopython/> make -C Doc latexpdf
116-
drevil:~tmp1/biopython/> cp Doc/_build/latex/Biopython_doc.pdf Doc/
117-
drevil:~tmp1/biopython/> make clean -C Doc
118-
```
119-
120-
12. make the source distribution
109+
11. make the source distribution
121110

122111
``` bash
123112
drevil:~tmp1/biopython> python setup.py sdist --formats=gztar,zip
124113
```
125114

126-
13. untar the file somewhere else
115+
12. untar the file somewhere else
127116

128117
``` bash
129118
drevil:~tmp1/biopython/> cd ..
130119
drevil:~tmp1/> tar -xzvf biopython/dist/biopython-1.78.tar.gz
131120
drevil:~tmp1/> cd biopython-1.78
132121
```
133122

134-
Check to make sure it includes the documentation PDF file under Doc
135-
136-
14. make sure I can build (won't install and use this) and test it (using the tar-ball test files):
123+
13. make sure I can build (won't install and use this) and test it (using the tar-ball test files):
137124
138125
``` bash
139126
drevil:~tmp1/biopython-1.78/> python -m pip install . --prefix /tmp/test-install
@@ -146,7 +133,7 @@ Making and testing the tar-ball
146133
Checking the compiled documentation
147134
-----------------------------------
148135
149-
15. Since Biopython 1.74, Sphinx has handled the API documentation via continuous
136+
14. Since Biopython 1.74, Sphinx has handled the API documentation via continuous
150137
integration, but you still have to update the "latest" symlink.
151138
152139
``` bash
@@ -163,7 +150,7 @@ Checking the compiled documentation
163150
Making wheels
164151
-------------
165152
166-
17. Now we use https://github.com/biopython/biopython-wheels to build wheels,
153+
15. Now we use https://github.com/biopython/biopython-wheels to build wheels,
167154
by updating the ``git checkout`` line in ``.github/workflows/cibuildwheel.yml``
168155
to the new release's commit hash (which all being well will get a git tag).
169156

@@ -188,26 +175,26 @@ Making wheels
188175
$ git push origin master
189176
```
190177
191-
18. Successful wheels will in an ``artifact.zip`` file available in the footer of the
178+
16. Successful wheels will in an ``artifact.zip`` file available in the footer of the
192179
run via [GitHub Actions runs](https://github.com/biopython/biopython-wheels/actions).
193180
Download this and unzip to your ``~/repository/biopython/DIST/`` folder.
194181
We will upload these to PyPI later using Twine.
195182
196-
19. If you have a Windows machine, remove any prior Biopython installations,
183+
17. If you have a Windows machine, remove any prior Biopython installations,
197184
and confirm the Windows wheel file(s) work.
198185
199186
Tagging the release, and uploading
200187
----------------------------------
201188
202-
20. Back in the main repository, tag the release:
189+
18. Back in the main repository, tag the release:
203190
204191
``` bash
205192
$ cd .../tmp1/biopython/
206193
$ git tag biopython-178
207194
$ git push origin master --tags
208195
```
209196
210-
21. Upload the new release tar-ball and zip to the website via GitHub Pages `DIST` repository.
197+
19. Upload the new release tar-ball and zip to the website via GitHub Pages `DIST` repository.
211198
212199
``` bash
213200
$ cp dist/biopython-1.78.* ~/repositories/DIST/
@@ -220,7 +207,7 @@ Tagging the release, and uploading
220207
$ git push origin gh-pages
221208
```
222209
223-
22. Upload to the python package index (except for beta/alpha level releases):
210+
20. Upload to the python package index (except for beta/alpha level releases):
224211
225212
``` bash
226213
$ cd ~/repositories/biopython/
@@ -234,7 +221,7 @@ Tagging the release, and uploading
234221
235222
- Check this is live at <https://pypi.python.org/pypi/biopython/>
236223
237-
23. Update the website:
224+
21. Update the website:
238225
239226
- If you haven't already, clone the ``biopython.github.io`` repository,
240227
(otherwise make sure your copy is up to date):
@@ -260,7 +247,7 @@ Tagging the release, and uploading
260247
proof-reading/final corrections.
261248
- Make sure the download links work.
262249

263-
24. Announcement:
250+
22. Announcement:
264251

265252
- post the announcement on the [www.open-bio.org](https://www.open-bio.org)
266253
blog (making sure to use the Biopython category which will update the
@@ -270,15 +257,15 @@ Tagging the release, and uploading
270257
- forward the email to Linux packagers e.g.
271258
272259

273-
25. Conda-Forge should automatically open a pull request to update the
260+
23. Conda-Forge should automatically open a pull request to update the
274261
package once it appears on PyPI. Check for a new pull request on
275262
[github.com/conda-forge/biopython-feedstock](https://github.com/conda-forge/biopython-feedstock)
276263
which once merged will upload the new release to [anaconda.org/conda-forge/biopython](https://anaconda.org/conda-forge/biopython)
277264

278265
Post release version bump
279266
-------------------------
280267

281-
26. Bump version numbers again
268+
24. Bump version numbers again
282269

283270
- Update `Bio/__init__.py` version
284271
- Start entry in `NEWS.rst` for next version

0 commit comments

Comments
 (0)