pygame documentation updates

-
There are some documentation updates on https://www.pygame.org/docs/


The website documentation builder was waiting for updates from bitbucket(our previous code host). lol? oops. Robots running in the cloud doing things no one wants them to do anymore. I had to write a new github integration, so now commits to master on github/pygame/pygame will cause the website docs to be rebuilt automatically again.

And python -m pygame.docs didn't work with the wheel builds... because they don't include docs (for some reason). So now, if the docs can't be found locally, it opens the web browser instead.
There were a bunch of documentation updates from Ian Mallett and Lenard Lindstrom which are finally up on the website. Lots of editing, and improvements to the tutorials.
Additionally a bunch of old links were fixed. Mostly to point to https:// versions of pages.
The docs are being built with a new version of Sphinx, which has nicer output in a few ways. See http://www.sphinx-doc.org/en/master/changes.html#release-1-7-0-released-feb-12-2018

Since it was a major version upgrade of Sphinx, there were some small expected issues to deal with, including their python API being broken/deprecated (just call the command line program instead), and disabling the on-by-default smart quotes(which are terrible for people copy pasting code examples).

Also, the launchpad PPA is building again. It got stuck because someone snuck a gpg field in their git commit, which broke the bzr mirror code. Except the packaging for that ppa is from 2013... and needs updating. Luckily it seems a few people have done the packaging work in various flavours of Debian... but somehow none of them have gone through. But anyway... The badge is getting made again(displayed on the readme) with the github webhook, and will alert us if things break on ubuntu/i386/amd64/arm7f.

Speaking of badges... there's now a 'commits since last release' badge on the https://github.com/pygame/pygame Which links to a diff between the last release.

Finally, I updated all the old bitbucket wiki pages to point to the same link on the pygame wiki (https://www.pygame.org/wiki). eg, https://bitbucket.org/pygame/pygame/wiki/CookBook points to https://www.pygame.org/wiki/CookBook

Comments

Post a Comment

Popular posts from this blog

Draft 3 of, ^Let's write a unit test!^

-
Image
So, I started writing this for people who want to 'contribute' to Community projects, and also Free Libre or Open source projects. Maybe you'd like to get involved, but are unsure of where to begin? Follow along with this tutorial, and peek at the end in the "what is a git for?" section for explanations of what some of the words mean. Draft 1, 2018/07/18 - initial draft. Draft 2, 2019/11/04 - two full unit test examples, assertions, making a pull request, use python 3 unittest substring search, "good first issue" is a thing now. Started "What is a git for? Jargon" section. Draft 3, 2020/12/12 - default branch name is main. What's first? A test is first. A unit test is a piece of code which tests one thing works well in isolation from other parts of software. In this guide, I'm going to explain how to write one using the standard python unittest module, for the pygame game library. You can apply this advice to most python pr...
Read more

Is PostgreSQL good enough?

-
Image
tldr; you can do jobs, queues, real time change feeds, time series, object store, document store, full text search with PostgreSQL. How to, pros/cons, rough performance and complexity levels are all discussed. Many sources and relevant documentation is linked to. Your database is first. But can PostgreSQL be second? Web/app projects these days often have many distributed parts. It's not uncommon for groups to use the right tool for the job. The right tools are often something like the choice below. Redis for queuing, and caching. Elastic Search for searching, and log stash. Influxdb or RRD for timeseries. S3 for an object store. PostgreSQL for relational data with constraints, and validation via schemas. Celery for job queues. Kafka for a buffer of queues or stream processing. Exception logging with PostgreSQL (perhaps using Sentry) KDB for low latency analytics on your column oriented data. Mongo/ZODB for storing documents JSON (or mangodb for /dev/null replacemen...
Read more

post modern C tooling - draft 6

-
Image
Contemporary C tooling for making higher quality C, faster or more safely. DRAFT 0 - 10/11/18,  DRAFT 1 - 9/16/19, 7:19 PM, I'm still working on this, but it's already useful and I'd like some feedback - so I decided to share it early. DRAFT 2 - 10/1/19, mostly additions to static analysis tools. DRAFT 3 - 10/4/19, updates on build systems, package management, and complexity analysis.  DRAFT 4 - 10/6/19, run time dynamic verification and instrumentation, sanitizers (asan/ubsan/etc), performance tools, static analyzers. DRAFT 5 - C interpreter(s).  DRAFT 6 - 11/6/19 , mention TermDebug vim,  more windows debugging tools, C drawing for intro. In 2001 or so people started using the phrase "Modern C++". So now that it's 2019, I guess we're in the post modern era? Anyway, this isn't a post about C++ code, but some of this information applies there too. No logo, but it's used everywhere. Welcome to the post modern era. S...
Read more