A couple months ago, we came under the largest DDoS attack we'd personally seen at Read the Docs. We wrote up a port-mortem on the anatomy of the attack, what we did to stop it, and what parts of it linger today (TLDR: AI makes DDoS easier)
about.readthedocs.com/blog/2026/09/2026-ddos-attack/
Read the Docs
Read the Docs is an open-sourced free software documentation hosting platform. It generates documentation written with the Sphinx documentation generator, MkDocs, or Jupyter Book. More on Wikipedia
-
Read the Docs
@readthedocs
-
Read the Docs
@readthedocs
We are currently dealing with an ongoing DDOS attack against our infrastructure, which is resulting in us having to enable more checks on documentation and dashboard pages. Please let us know if you have issues while connecting to our sites:
docs.readthedocs.com/platform/stable/support.html -
Read the Docs
@readthedocs
Automation rules can now filter builds based on webhook payload contents β one of the most requested features weβve received -- along with more flexibility.
about.readthedocs.com/blog/2026/06/automation-rules-v2 -
Read the Docs
@readthedocs
We are excited to announce that Read the Docs now supports `uv` natively in .readthedocs.yaml. Speed up your builds and deploy fast! π
about.readthedocs.com/blog/2026/04/uv-native-support/ -
Read the Docs
@readthedocs
We have enabled automatic Markdown conversion for documentation pages on our PR build domains, as a way to test this feature. This makes it easier for automated scripts and AI agents to access your docs.
Read more and give us feedback here: github.com/readthedocs/readthedocs.org/issues/12512 -
Read the Docs
@readthedocs
Tired of AI agents making up API details? We are too.
We're experimenting with AI Skills as a way to handle this,
and have some released some official RTD skills to get the ball rolling.
Try them out: about.readthedocs.com/blog/2026/02/readthedocs-skills-apiβ¦
Read the Docs
@readthedocs
Our first skill is our API skill,
which teaches your API agent how to use our API.
This is great for managing your redirects, builds, or other tasks automatically.
Read the Docs
@readthedocs
Our second skill is for our YAML config,
it will help write your config files with the latest features.
This is an attempt at reducing hallucinations,
and something we hope to experiment more with in the future. -
Read the Docs
@readthedocs
Docs aren't just for humans anymore π€π
We now support llms.txt & llms-full.txt, served directly from the root of your docs domain. This gives LLMs clean, structured context straight from your documentation, with minimal setup.
Learn more in our docs: docs.readthedocs.com/platform/stable/reference/llms-txt.html -
Read the Docs
@readthedocs
Have you noticed that searching on Read the Docs feels snappier? β‘οΈ
We've reduced the average response times by more than 50%:
- Community: 210ms β 97ms
- Business: 570ms β 205ms
Check out our blog post to learn how we achieved this π
about.readthedocs.com/blog/2026/02/faster-search/ -
Read the Docs
@readthedocs
We're thinking more about engaging with AI as a docs platform. Taking it slowly and making sure it works for authors, open source, and the software ecosystem. We wrote up a recommendation and what we learned from a conference talk that covers this well.
about.readthedocs.com/blog/2025/11/docs-ai-tools/ -
Read the Docs
@readthedocs
We're currently under a large DDOS attack, and have dialed up our firewall settings to try and stay online for normal users. Please let us know if you are seeing any additional issues accessing documentation pages.
-
Read the Docs
@readthedocs
Thanks to Amazon Web Services (AWS) for providing credits for our Community platform. It helps us provide continued documentation hosting for the open source community, and be a reliable part of the ecosystem for almost 15 years now (!!).
Read more: about.readthedocs.com/blog/2025/09/aws-powers-read-the-docs/ -
Read the Docs
@readthedocs
Thanks so much to AWS for continuing to provide free credits for our Community platform. It helps us provide documentation hosting for the open source community, and be a reliable part of the ecosystem for almost 15 years now (!!).
Read more: about.readthedocs.com/blog/2025/09/aws-powers-read-the-docs/
Fabio Oliveira (@fbdo@hachyderm.io)
@fbdo
We're thrilled to support @readthedocs through our Open Source Credits program! π
π 100k+ open source projects
π» Millions of developers served
π $500k in AWS credits since 2021
Together, we're building a stronger #opensource ecosystem. Learn more: go.aws/45TFXtW -
Read the Docs
@readthedocs
We're excited to announce our GitHub App -- allowing more granular permissions and additional functionality around PR builds. You can start using the new GitHub App today on our Community site in beta. We plan to start testing with our Business users soon.
about.readthedocs.com/blog/2025/06/announcing-our-github-β¦ -
Read the Docs
@readthedocs
We had an outage on Business documentation sites due to a phishing attack that caused our domain to be suspended with 48 hours notice and breaking DNS resolution for all customer sites. We have deleted the malicious sites and are waiting for our domain to be reinstated.
-
Read the Docs
@readthedocs
We have been experiencing an attack for the past 2 days, which has been causing some 429 issues for some users. This is faking normal browser User-Agents, which is making it hard to block without also causing some captchas and rate limits for users. We're working to resolve it.
-
Read the Docs
@readthedocs
We've been working hard on Addons. They are the Javascript application that we embed into documentation pages, which exposes a number of features and data for you to build integrations. This allows things like integrating our Versions and Offline formats into your documentation.
Read the Docs
@readthedocs
We're going to do a series of posts highlighting some of our Addons features, but to start here is our blog post sharing a bit more of the history and technology that we're building on top of.
about.readthedocs.com/blog/2024/07/addons-by-default/ -
Read the Docs
@readthedocs
Today we're highlighting Antora, a tool built on top of Asciidoc to render a full documentation site. We've big fans of all the various plain text markup languages, so give this one a try!
docs.readthedocs.com/platform/stable/intro/antora.html -
Read the Docs
@readthedocs
Today we're highlighting our support for Docusaurus, which is a JS doc tool that originally came out of Facebook. It's a great choice for folks in the JS ecosystem who want a fully featured site out of the box.
Learn how to deploy it easily:
docs.readthedocs.com/platform/stable/intro/docusaurus.html -
Read the Docs
@readthedocs
Just a reminder that we're doing a scheduled downtime event in 30 minutes today at 2:00 PM PST. We expected 15-30 minutes of downtime for each our Business and Community sites, but public docs should continue serving.
More details here: about.readthedocs.com/blog/2025/02/postgres-maint-feb-14/ -
Read the Docs
@readthedocs
Markdoc is a project open sourced by Stripe. You can host it with us by doing a static build of your doc site, and get all the building and hosting features of Read the Docs.
docs.readthedocs.com/platform/stable/intro/markdoc.html -
Read the Docs
@readthedocs
Our February newsletter is out:
* Scheduled downtime on February 14 for DB maintenance
* Flyout position can now be easily changed.
* We moved our docs to `docs.readthedocs.com`
* Lots more!
about.readthedocs.com/blog/2025/02/newsletter-february-2025/ -
Read the Docs
@readthedocs
Read the Docs will be having a scheduled downtime on Friday, February 14 at 2:00pm PST (5:00pm EST, 22:00 UTC). This will apply to both Community and Business users, and will last 2 hours. We expect downtime to be 15-20 minutes per site.
Read more: about.readthedocs.com/blog/2025/02/postgres-maint-feb-14/ -
Read the Docs
@readthedocs
Today we're highlighting our support for VitePress. It's a great option for those in the JS ecosystem that want a full featured doc site with a landing page and beautiful default theme.
docs.readthedocs.com/platform/stable/intro/vitepress.html
Read the Docs
@readthedocs
Check out the DbToolsBundle for a production example of someone using it on Read the Docs:
dbtoolsbundle.readthedocs.io/en/stable/ -
Read the Docs
@readthedocs
We're starting to promote our support for other doctools, starting with mdBook. You can see how to quickly get started and a basic example repository in our documentation:
docs.readthedocs.io/en/stable/intro/mdbook.html -
Read the Docs
@readthedocs
We've put together a blog post that shares our product vision for Read the Docs. The platform has been in transition from a Sphinx-focused platform to a docs as code platform that works with any tool.
Please read the post and share any feedback.
about.readthedocs.com/blog/2025/01/2025-vision/ -
Read the Docs
@readthedocs
We had a production incident on Read the Docs Community that caused some builds and API requests to fail from 8am to 10am Pacific Time today. All issues are resolved, and builds should be happening normally again.
-
Read the Docs
@readthedocs
Reminder: Today is the day that Addons are enabled by default, and build context is not automatically injected. Please check your docs builds and ensure everything is working properly, and contact support if you need assistance. Info in on our blog:
about.readthedocs.com/blog/2024/07/addons-by-default/
Read the Docs
@readthedocs
This change will update our Flyout to change its visual display, and remove the automatic injection of Sphinx variables that RTD previously set. This might possibly change build behavior and documentation display. See our blog post about adapting this behavior.
-
Read the Docs reposted
Santos Gallegos
@stsewd
Guess who's in Durham π for #djangocon?
I have @readthedocs and @pyecuador stickers! Say hi! -
Read the Docs
@readthedocs
In our September newsletter:
* 10 years of being sustainable
* SAML SSO is now available for Business users
* MFA login is coming to both platforms soon
* API v3 now supports unauthenticated requests on many detail views
* and more )
about.readthedocs.com/blog/2024/09/newsletter-september-2β¦ -
Read the Docs
@readthedocs
π₯³ We turned 10 years old! π
Read more about how we made our company sustainable over these years without VC.
We are grateful for all the support our users and customer gave us in this journey. Without it, we wouldn't be here π
about.readthedocs.com/blog/2024/08/10-year-anniversary/ -
Read the Docs
@readthedocs
In our August newsletter:
* New versions of our Sphinx theme
* We've removed Google Analytics integration (you can still set it up yourself)
* API v3 supports more unauthenticated requests
* Build customization & Addons out of beta
* Lots more
about.readthedocs.com/blog/2024/08/newsletter-august-2024/ -
Read the Docs
@readthedocs
AI crawlers have downloaded over 100 TB in the last couple months, partially from bugs and abusive behavior. We ask AI crawlers to include rate and bandwidth limits, and ask them to partner with us to mitigate impact and support our work.
about.readthedocs.com/blog/2024/07/ai-crawlers-abuse/
Read the Docs
@readthedocs
You can see the impact of this even when the files are behind a CDN. Many of the files they are crawling are large and not frequently accessed, which causes a huge amount of traffic to origin servers, adding bandwidth and server costs.
-
Read the Docs reposted
Read the Docs
@readthedocs
AI crawlers have downloaded over 100 TB in the last couple months, partially from bugs and abusive behavior. We ask AI crawlers to include rate and bandwidth limits, and ask them to partner with us to mitigate impact and support our work.
about.readthedocs.com/blog/2024/07/ai-crawlers-abuse/ -
Read the Docs
@readthedocs
Highlights from the last couple months:
* We shipped Ubuntu 24.04
* Addons will be deployed for everyone soon
* Our new dashboard is now at the `app.` domain, moving out of beta
* We're testing SAML SSO (Business users)
about.readthedocs.com/blog/2024/07/newsletter-july-2024/ -
Read the Docs
@readthedocs
Highlights for April:
* We're going to be beta testing SAML support soon on RTD Business
* Addons are being rolled out to all Mkdocs projects soon
* We're adding custom JS integration for Addons
* and lots more!
about.readthedocs.com/blog/2024/04/newsletter-april-2024/ -
Read the Docs
@readthedocs
Our March 2024 newsletter:
* We added latest aliases and Ruby to our build tools
* We improved multiple format build performance for Sphinx
* We're starting to link to our new dashboard on build pages
* Lots more!
about.readthedocs.com/blog/2024/03/newsletter-march-2024/ -
Read the Docs
@readthedocs
In our February 2024 newsletter:
* We moved our blog to our new website π
* Forced redirects are available to all users
* We continue to improve our new Dashboard & Addons betas - getting close to official release
* Lots more!
about.readthedocs.com/blog/2024/02/read-the-docs-newslett⦠-
Read the Docs
@readthedocs
We've recently added support for version-only projects. This long-requested feature allows you to serve docs at URLs without a translation (eg. `/latest/` or `/3/`).
Read more in our blog post: blog.readthedocs.com/introducing-support-for-version-only⦠-
Read the Docs
@readthedocs
Just a warning that today we are not installing any additional build dependencies by default. You'll need to pin your requirements in your config file, or you'll get the latest version of Sphinx & Mkdocs.
blog.readthedocs.com/defaulting-latest-build-tools/ -
Read the Docs
@readthedocs
Just a heads up, logged our users to both our Community & Business sites will now be redirected to our new marketing site. Logged in users will be redirected to the dashboard pages. We'd love any feedback on our new site β¨
about.readthedocs.com -
Read the Docs
@readthedocs
ποΈ We just published our July 2023 Newsletter:
blog.readthedocs.com/newsletter-july-2023/ -
Read the Docs
@readthedocs
In our latest newsletter:
β οΈ A .readthedocs.yaml configuration file will be required for your future builds
β οΈ /<lang>/ now redirects to /<lang>/version/
ποΈ Support for multiline build.commands fixed
ποΈ Security fixes
blog.readthedocs.com/newsletter-june-2023/ -
Read the Docs
@readthedocs
The most recent addition to our awesome projects list is Ray's documentation πΆοΈ.
Ray by @anyscalecompute is an open source project, consisting of several components that all have their own section in a combined documentation set.
docs.ray.io/en/latest/
Here is a π€ (small) π§΅Post not available here, view on X
Read the Docs
@readthedocs
Finally, a big +1 to using tabular interfaces in documentation instructions to let the user easily activate relevant content (and hide the irrelevant content). π―οΈ
To achieve this, Ray uses sphinx-tabs: sphinx-tabs.readthedocs.io
Read the Docs
@readthedocs
Thatβs it for now π
Know another awesome project? Interested in more inspiration? Check out our Awesome Read the Docs Projects repository on GitHub: github.com/readthedocs-examples/awesome-read-the-docs -
Read the Docs
@readthedocs
We will start requiring a ".readthedocs.yaml" configuration file soon, π
Read more about the deprecation and how to add .readthedocs.yaml to your project:
blog.readthedocs.com/migrate-configuration-v2/ -
Read the Docs reposted
Write the Docs
@writethedocs
Writing Day roll call for @writethedocs Portland 2023 (1 of 2)!
Get excited to meet folks from:
@readthedocs
@DocDetctivTests
#mutualaidforwriters hosted by @rainbowkenz
@gitlab
Step-ca by @smallsteplabs
@Raspberry_Pi
Find details at: www.writethedocs.org/conf/portland/2023/writing-day/ -
Read the Docs
@readthedocs
May newsletter:
ποΈ Our docs proxy, El Proxito, has been rewritten.
ποΈ β¦one of its new features is an improved 404 page.
πͺοΈ Support for multiple .readthedocs.yaml files in the same repository.
ποΈ Fixed: urllib3 issues in legacy build images.
blog.readthedocs.com/newsletter-may-2023/ -
Read the Docs
@readthedocs
We started an Awesome List and it now has enough entries for a premiere πΆοΈ
Additional suggestions for the list are most welcome. We occasionally showcase new entries on Twitter, Mastodon and in our newsletter.
Thanks for the boost @awesome__re ποΈ
Awesome
@awesome__re
Awesome Read the Docs
Example documentation projects to inspire and help bootstrap new documentation projects.
github.com/readthedocs-examples/awesome-read-the-docs -
Read the Docs
@readthedocs
April ποΈ:
π Documentation navigation aligned with DiΓ‘taxis - thanks @evildmp β€οΈ
βοΈ 4 new environment variables for builds
ποΈ All our websites use @PlausibleHQ for analytics.
β‘οΈ A beta JavaScript client for all documentation frameworks
blog.readthedocs.com/newsletter-april-2023/ -
Read the Docs
@readthedocs
A recent addition to our list of awesome projects πΆοΈ: @crateio
@crateio combines multiple documentation projects into the same website experience.
Oh, by the way, the @crateio docs will turn 10 years old in July ποΈ
crate.io/docs/crate/tutorials/en/latest/
Here is a π€ (small) π§΅Post not available here, view on X
Read the Docs
@readthedocs
The navigation menu consists of all their documentation projects + the sections contained in the documentation project thatβs selected.
Each of the sections indicated here is an individual Sphinx project, GitHub repository and Read the Docs project.
Read the Docs
@readthedocs
But why have 15 individual Sphinx and Read the Docs projects instead of one βοΈ
Choosing this approach gives each documentation project its own versioning scheme and release flow, as well as its own community of contributors and maintainers πͺοΈ
Read the Docs
@readthedocs
At Read the Docs, we are very interested in methods to host and combine multiple projects at scale. Weβll be showcasing more examples, as well as expanding the platformβs support and documentation for different approaches.
Read the Docs
@readthedocs
Thatβs it for now π
Know another awesome project? Interested in more inspiration? Check out our Awesome Read the Docs Projects repository on GitHub: github.com/readthedocs-examples/awesome-read-the-docs -
Read the Docs
@readthedocs
Pablo Galindo Salgado
@pyblogsal
PEP 701 is accepted! πππππ€
github.com/python/peps/pull/3056
Thanks to my awesome co-authors @isidentical @lysnikolaou and for the community for your help making the proposal even better. -
Read the Docs reposted
Adam βMastodon or Blueskyβ Johnson
@AdamChainz
Trying out ads for Boost Your Django DX on @readthedocs π
-
Read the Docs
@readthedocs
We are launching our new website one step at a time π
In this blog post, we share a few more details about the migration plan, and how we're using our own tools to deploy it.
blog.readthedocs.com/website-migration/
Read the Docs
@readthedocs
One of the cool parts of our website is that we are now presenting our Community support options in the context of our pricing page.
about.readthedocs.com/pricing/
/cc @chadwhitacre -
Read the Docs
@readthedocs
March newsletter highlights:
πͺοΈ Significant improvements in build times
π¬οΈ Updates on our dashboard v2 and new marketing website
ποΈ More info on our documentation refactor
π Removal of unofficial projects from search engines via robots.txt
blog.readthedocs.com/newsletter-march-2023/ -
Read the Docs
@readthedocs
The Haskell Tool Stack is a packaging tool for #haskell. Because their documentation is so awesome, itβs also their main website π―
Stackβs website is maintained with GitHub, MkDocs, and Read the Docs: docs.haskellstack.org
Here is a π€ (small) π§΅ about why itβs awesome πΆοΈPost not available here, view on X
Read the Docs
@readthedocs
Stackβs categorization nears the DiΓ‘taxis methodology (diataxis.fr), which is great for readers to engage with various areas of the docs. We recommend using some kind of content system like this, so users and authors understand the structure.
Read the Docs
@readthedocs
Thatβs it for now π
Know another awesome project? Interested in more inspiration? Check out our Awesome Read the Docs Projects repository on GitHub:
github.com/readthedocs-examples/awesome-read-the-docs -
Read the Docs reposted
Chris Sewell
@chrisj_sewell
Hi all π,
I'm pleased to announce a new release of myst-parser (and myst-docutils),
that brings a number of exciting new features, improvements, and upgrades π
myst-parser.readthedocs.io
@readthedocs @myst_tools @choldgraf @rowancockett -
Read the Docs reposted
Read the Docs
@readthedocs
We're excited to be an official sponsor of the conference this year. You can meet up with @reydelhumo and learn more about how we support all your doc tools with a nicely integrated platform. β
Write the Docs
@writethedocs
π£Our Portland conference talk lineup is out! We're excited to welcome you back in person with these excellent speakers. Our Call for Volunteers is also out, and our Opportunity Grant deadline is March 1. See you on ποΈ May 7-9!
www.writethedocs.org/conf/portland/2023/news/announcing-s⦠-
Read the Docs
@readthedocs
We're excited to be an official sponsor of the conference this year. You can meet up with @reydelhumo and learn more about how we support all your doc tools with a nicely integrated platform. β
Write the Docs
@writethedocs
π£Our Portland conference talk lineup is out! We're excited to welcome you back in person with these excellent speakers. Our Call for Volunteers is also out, and our Opportunity Grant deadline is March 1. See you on ποΈ May 7-9!
www.writethedocs.org/conf/portland/2023/news/announcing-s⦠-
Read the Docs reposted
Eric Holscher
@ericholscher
This was a huge amount of work! We're gonna do a blog post on it here soon, but really excited to get our docs refactor out into the world. π
So much love to @evildmp for DiΓ‘taxis, and his wonderful ideas at @DjangoConEurope last year. π
Read the Docs
@readthedocs
πΌοΈWe're also excited to ship our refactored documentation using this framework. This is definitely still a v1 with more changes incoming, but we're excited about the progress here. β¨
docs.readthedocs.io/en/stable/ -
Read the Docs
@readthedocs
Our core team member @ericholscher gave a talk about documentation at the recent @DjangoCon US. The talk gives an overview of DiΓ‘taxis, an exciting new approach to documentation. We'll be sharing more on our own transition to DiΓ‘taxis soon! π
www.youtube.com/watch?v=mqn0D4xat58
Read the Docs
@readthedocs
You can learn more about DiΓ‘taxis after this talk on it's website:
diataxis.fr
Read the Docs
@readthedocs
πΌοΈWe're also excited to ship our refactored documentation using this framework. This is definitely still a v1 with more changes incoming, but we're excited about the progress here. β¨
docs.readthedocs.io/en/stable/ -
Read the Docs reposted
Chris Sewell
@chrisj_sewell
Wellβ¦ whilst you are talking about documentation and myst, check out the knew documentation Iβve been working on π myst-parser--717.org.readthedocs.build/en/717/ a lot more structured, and a lot more examples π
-
Read the Docs reposted
Write the Docs
@writethedocs
Have you ever thought: I wish I knew what professional docs people think about <topic>, then I have just the solution for you:
www.writethedocs.org/topics/
It's a categorized list of every newsletter writeup and conference talk, by topic. Curated and crowd sourced. πͺ -
Read the Docs
@readthedocs
We reached the 10,000th issue/PR number on GitHub!
ποΈ 1οΈβ£οΈ0οΈβ£οΈ0οΈβ£οΈ0οΈβ£οΈ0οΈβ£οΈ ποΈ
And not surprisingly, it's one of the busiest contributors and core team members @stsewd who opened it!
github.com/readthedocs/readthedocs.org/pull/10000 -
Read the Docs
@readthedocs
We compiled a list of many Awesome Read the Docs projects π! You can use them to get new inspiration π§ββοΈ for your documentation π
Know a cool project π€© that should be added? Feel free to send a pull request or comment here.
See the full list: github.com/readthedocs-examples/awesome-read-the-docs -
Read the Docs
@readthedocs
We fixed a long standing bug π that we are sure you hit lot of times! It was really difficult to skim the build output's page and quickly read the commands executed. That's old news! Now, Read the Docs is showing them in a pretty clear way π―
-
Read the Docs
@readthedocs
January newsletter highlights:
πΉοΈ DjangoCon US talk covering DiΓ‘taxis & Sphinx basics.
π’οΈ Sphinx 6 is released. If you want things to not break, itβs good to wait a bit.
ποΈHighlights from the roadmap.
ποΈ Security updates (no action required).
blog.readthedocs.com/newsletter-january-2023/ -
Read the Docs
@readthedocs
Did you hear that Sphinx 6 was released? ποΈ
Read our consideration before upgrading to avoid breaking your builds: blog.readthedocs.com/sphinx6-upgrade/ -
Read the Docs
@readthedocs
We welcome well-behaved bots. We implemented some generous rate limiting for folks accessing documentation at around ~4 req/s (<250/min). We want to accommodate you while also keeping things accessible and available to humans.π€ If you need faster access, get in touch.
-
Read the Docs
@readthedocs
π Find unused (orphaned) files in your projects with "mkdocs-unused-files" #mkdoc's plugin. Pretty useful when working on medium-to-big projects with multiple images in your docs.
Read the full docs at π github.com/wilhelmer/mkdocs-unused-files -
Read the Docs
@readthedocs
GeoPandas is an open source project to make working with #geospatial data in #python easier. @GeoPandas extends the datatypes used by pandas to allow spatial operations on geometric types.
We want to highlight some things we love from their docs.
π€ (small) π§΅Post not available here, view on X
Read the Docs
@readthedocs
π Very detailed API reference with all the parameters, along with usage examples that you can quickly copy and paste without worrying about the Python prompt!
Read the Docs
@readthedocs
We are excited to have them hosted on Read the Docs! We hope their documentation inspires you to improve your own docs and share them with the world!
Let us know which docs you like the most and we will highlight it on our next episode β‘ -
Read the Docs
@readthedocs
Our tip of the month is sphinx-timeline written by @chrisj_sewell: Use this new extension to add milestones, organization history, roadmaps or any other timelines to your documentation project.
Incidentally we happened to agree with this π―οΈοΈ ‡οΈ
Daniel Woste
@DanWos
Just detected a nice, new extension for timelines in #sphinxdoc
Sphinx-Timeline:
sphinx-timeline.readthedocs.io/en/latest/
Written by Chris Sewell.
Give it a try and if you love it also a github star :) -
Read the Docs
@readthedocs
We are creating a curated π and opinionated list of amazing β¨ Sphinx extensions that we want to make more visible for our users. Each of them has a small page with a live usage example and a pretty minimal configuration βοΈ setup. Check them out at π sphinx-extensions.readthedocs.io!
-
Read the Docs
@readthedocs
Hello Twitter folks π! We want to let you know we are on Mastadon too π! Come and join us at fosstodon.org/@readthedocs
-
Read the Docs
@readthedocs
We always love to see the interesting things folks are doing with their documentation. Any favorite examples that you've seen lately that we should break down in our ongoing Showcase the Docs threads?
#writethedocs #techcomm #awesomedocs -
Read the Docs reposted
Read the Docs
@readthedocs
We just published "Override the build process completely" post βοΈ announcing our new beta feature π€© that allows you... Well, exactly that π , override the default Read the Docs commands and customize the build process as much as you need. Read it at blog.readthedocs.com/build-customization/
-
Read the Docs reposted
Read the Docs
@readthedocs
Wondering how to skip a build that doesn't contain changes in "docs/" directory? Now you can do that by writing a user-defined command that exits with 183 code. This example uses Bash and "git diff" to check the condition. Read the full documentation at docs.readthedocs.io/en/stable/builds.html
-
Read the Docs
@readthedocs
Nautobot is the project of our todayβs π« Showcase the Docs π edition!
βAn extensible and flexible Network Source of Truth and Network Automation Platform that is the cornerstone of any network automation architectureβ #nautobot #documentationPost not available here, view on X
Read the Docs
@readthedocs
Nautobot documentation also makes use of the multi-version π feature. This helps readers always read the exact documentation for the version they are using
Read the Docs
@readthedocs
We are excited to have them with us! We hope their documentation inspires you to improve your own docs and share them with the world!
Let us know which docs you like the most and we will highlight it in the next episode β‘ -
Read the Docs
@readthedocs
Our tip of the month consists of two projects maintained by @AdamChainz - both save us a lot of time:
π blacken-docs keeps our documentation examples written in Python syntactically correct and neat
π django-upgrade helps us automate our Django upgrade process
Thanks Adam π
Read the Docs
@readthedocs
More info about blacken-docs: github.com/adamchainz/blacken-docs/
Also big shoutout to @codewithanthony who originally started blacken-docs and a lot of other wonderful pre-commit hooks β€οΈ
Read the Docs
@readthedocs
You can also watch @AdamChainz's lightning talk about django-upgrade from DjangoCon Europe 2022: www.youtube.com/watch?v=c6X9cSP6AZo&t=1625s
-
Read the Docs
@readthedocs
Get the latest news about the Read the Docs ecosystem πΊοΈ! Subscribe to our newsletter π° to not miss a word from us! blog.readthedocs.com
-
Read the Docs
@readthedocs
Wondering how to skip a build that doesn't contain changes in "docs/" directory? Now you can do that by writing a user-defined command that exits with 183 code. This example uses Bash and "git diff" to check the condition. Read the full documentation at docs.readthedocs.io/en/stable/builds.html
-
Read the Docs
@readthedocs
Read the Docs uses shallow clone to reduce bandwidth usage and speed up π build time. However, if your build *requires* an unshallowed clone, you can do it by using "build.jobs" config key. Read the full docs at docs.readthedocs.io/en/stable/build-customization.html
-
Read the Docs
@readthedocs
We just published "Override the build process completely" post βοΈ announcing our new beta feature π€© that allows you... Well, exactly that π , override the default Read the Docs commands and customize the build process as much as you need. Read it at blog.readthedocs.com/build-customization/
-
Read the Docs
@readthedocs
Are you overriding your build using "build.commands"? We want to know more about your use case! π Please comment on this thread explaining how you are using it, paste a link to your config file βοΈ and tell us what would be a good "nice to have" β¨
docs.readthedocs.io/en/stable/build-customization.html -
Read the Docs
@readthedocs
We just released version 8.8.1 of our code to address a security vulnerability. It allowed an attacker to craft a version of docs that would be served on our main dashboard domain, and could use JavaScript to take control of the user session.
github.com/readthedocs/readthedocs.org/security/advisorie⦠-
Read the Docs
@readthedocs
November newsletter:
π± Auto-cancelling feature reduced builds by 10%
π¦ sphinxcontrib-jquery saves extensions and themes from adding jQuery in Sphinx 6
πΆοΈ Awesome Project: @WagtailCMS
β³ DiΓ‘taxis docs refactor, theme updates and more...
Read more: blog.readthedocs.com/newsletter-november-2022/ -
Read the Docs reposted
Catalyst Cooperative
@CatalystCoop
Weβve created a @readthedocs site containing our bylaws, policies and onboarding documents catalystcoop-handbook.readthedocs.io/en/latest/. This was inspired by @2i2c_orgβs Team Compass team-compass.2i2c.org/en/latest/. We hope these docs can be helpful for other small orgs and co-ops.
-
Read the Docs
@readthedocs
Python 3.11.0 π was released two weeks ago and you can now use it on Read the Docs to build your documentation π₯³. Upgrade it now! π
-
Read the Docs reposted
EthicalAds
@ethicaladsio
Excited to discuss our ML-powered approach to content targeting with @spacy_io. This is a crucial foundation for building world class ad targeting that respects privacy, and we're excited to share it with you.
tl;dr: π€ππ = π’π―π
www.ethicalads.io/blog/2022/11/a-new-approach-to-content-β¦ #privacy #adtech -
Read the Docs
@readthedocs
We are excited to announce the 1.1.0 release of "sphinx-rtd-theme", our theme for Sphinx π₯³. It's the first release in some time and we have more releases lined up in the roadmap.
Ideas, comments and contributions are most welcome!
blog.readthedocs.com/theme-release-110/ -
Read the Docs
@readthedocs
We're glad to have been given $250 from @getsentry on thanks.dev. This is for our work on the sphinx_rtd_theme, which is getting a new 1.1 release shortly! We love to see this activity in funding open source π
blog.sentry.io/2022/10/27/we-just-gave-260-028-dollars-to⦠-
Read the Docs
@readthedocs
β οΈ If you use GitLab, you may need to re-connect your account.
Some months ago, GitLab started enforcing an expiration time for their OAuth tokens, this broke the integration with our application.
Read more in our blog post blog.readthedocs.com/gitlab-service-reconection-required/ -
Read the Docs
@readthedocs
New feature: auto-cancelling builds when pushing to the same branch twice. Our blog post talks about the benefits, including a better UX for users, and reducing resource costs while saving energy as well! π± Read the blog post at blog.readthedocs.com/cancel-old-builds/
Read the Docs
@readthedocs
A small update after 21 days: 10% of the total builds πare cancelled daily because they are "overwritten" by a newer build
-
Read the Docs
@readthedocs
Are you using our Sphinx theme? A new release is coming up, and you can help test it by upgrading to the latest pre-release, 1.1.0b3. Install it with `pip install sphinx-rtd-theme==1.1.0b3` and make sure your docs look good!
Full changelog is here: sphinx-rtd-theme.readthedocs.io/en/latest/changelog.html -
Read the Docs
@readthedocs
We are seeing elevated HTTP 530 errors from our DNS provider. They have found the issue, and are currently deploying a fix. We expect it to be resolved soon.
-
Read the Docs
@readthedocs
In todayβs βShowcase the Docsβ we want to highlight the amazing documentation of the @WagtailCMS project π¦
> Wagtail is an open source CMS written in Python and built on the Django web framework.
docs.wagtail.org/en/latest/
π€ (small) π§΅Post not available here, view on X
Read the Docs
@readthedocs
Wagtail has been made by ~600 contributors. ~500 of them contributed to docs and most of whom (~350) to release notes. This is a win-winπ«±π»βπ«²πΌ: Hosting release notes in the docs gives readers a much richer experience and developers a good reason to dive into the docs project π
Read the Docs
@readthedocs
That's the end of the π§΅. Did you like it? Let us know if there are docs that you love and want us to highlight in the future. We love to hear more from authors and readers!
Keep documenting your project at Read the Docs: about.readthedocs.com -
Read the Docs
@readthedocs
Our October newsletter is out. It was a pretty slow month with a lot of the team traveling, but we shipped a few big things:
* We fully rolled out auto-cancelling builds
* Redirects can now be edited directly in the dashboard
Read the full notes at blog.readthedocs.com/newsletter-october-2022/ -
Read the Docs reposted
Antoine Beyeler
@abey79
Here is a short TIL article on adding GDPR-compliant and privacy-focused analytics to a @readthedocs-hosted #sphinxdoc web site using @PlausibleHQ. I show how to gather metrics in production builds only, to limit contamination from dev-related activities.
bylr.info/articles/2022/10/09/til-plausible-rtd/ -
Read the Docs
@readthedocs
We continued analyzing our data to understand how folks use our platform. This has already helped us detect anomalies in our data, abuse of the service, and make more informed decisions about prioritizing work. Read the full post at blog.readthedocs.com/knowing-more-about-ourselves/
-
Read the Docs
@readthedocs
It's been too long since anyone in our team has gotten together. We did a small meetup at @DjangoConEurope in Porto last week. With @ericholscher coming from Oregon, @reydelhumo from Barcelona, and @benjaoming from Malmo! We're hoping to get the whole team together soon.
-
Read the Docs reposted
Martin Donath
@squidfunk
It looks like RTD is working on deeper integration with (Material for) MkDocs π Feel free to share your painpoints when running Material for MkDocs on RTD.
Read the Docs
@readthedocs
Let us know if you have any issues! We are actively doing research on deeper integration with Mkdocs & Material, so any feedback or pain points are great to hear about.
-
Read the Docs reposted
EthicalAds
@ethicaladsio
We caught and stopped ad scammers impersonating open source devs to monetize their projects with ads. π¦ΉββοΈπ¦ΉββοΈ Our blog has details and how we detected them and kept our network safe. www.ethicalads.io/blog/2022/09/watch-out-ad-scammers-are-β¦
-
Post not available here, view on XPost not available here, view on X
Read the Docs
@readthedocs
Let us know if you have any issues! We are actively doing research on deeper integration with Mkdocs & Material, so any feedback or pain points are great to hear about.
-
Read the Docs
@readthedocs
We're excited to have a few members of our team meeting up at @DjangoConEurope (@ericholscher, @reydelhumo, @benjaoming), and helping promote the event as a community partner. We're excited to talk to everyone about docs, hear your product feedback, and we have stickers! π
-
Read the Docs
@readthedocs
Are you in doubt about which Sphinx theme to use? π¨
Take a look at sphinx-themes.org -- it has awesome live demos that will help you decide which theme is the best fit for your project. -
Read the Docs
@readthedocs
We're impressed by the documentation of @TorchIOLib and want to highlight it!
> TorchIO is an open-source Python library for efficient loading, preprocessing, [...] of 3D medical images in deep learning, following the design of PyTorch.
torchio.readthedocs.io/index.html
π€ (small) π§΅Post not available here, view on X
Read the Docs
@readthedocs
There is an Interactive example (done with p5js.org) to understand how the βQueueβ algorithm works! torchio.readthedocs.io/patches/patch_training.html
Read the Docs
@readthedocs
That's the end of the π§΅. Did you like it? Let us know if there are docs that you love and want us to highlight in the future. We love to hear more from authors and readers!
Keep documenting your project at Read the Docs: about.readthedocs.com -
Read the Docs
@readthedocs
We just published a new post: "Knowing more about how people use our service". It explains how we use the data we've collected to improve the UX and make better decisions. There are more pretty graphs with explanation in our post ππ§. Read it at blog.readthedocs.com/knowing-more-about-ourselves/
-
Read the Docs
@readthedocs
We shipped our September newsletter:
* We're testing a new landing page: about.readthedocs.com - would love your feedback!
* Multiple pushes to the same branch cancel all earlier builds
* Lots more updates, including docs & custom domain improvements
blog.readthedocs.com/newsletter-september-2022/ -
Read the Docs
@readthedocs
Badges are useful to quickly communicate to your users the status of your project on different services. We have our own that tells them the status of the documentation and link them directly to the homepage. They are great for READMEs! Full docs at docs.readthedocs.io/en/stable/badges.html
-
Read the Docs
@readthedocs
Are you a @discord user? π You can now receive notifications about triggered π‘, successful β and failed β builds right on your text channels! β¨
Set up a webhook πͺon your project and don't miss a build again! Full documentation at docs.readthedocs.io/en/stable/build-notifications.html -
Read the Docs
@readthedocs
We strongly recommend you to take a look at PyData Sphinx Theme! Even more now, that they just released a new version! It has a bunch of features that we love π
Take a look at the docs at pydata-sphinx-theme.readthedocs.io/en/latest/
Chris Holdgraf
@choldgraf
πNew Release!π PyData Sphinx Theme v0.10
The PyData Sphinx Theme is a clean and customizable three-column theme for and by the @PyData community.
This is a big overhaul of the header and sidebar behavior to be more consistent on wide and narrow screens.
A few highlights β¨ -
Read the Docs
@readthedocs
Did you know that you can set up Slack notifications for your builds on Read the Docs? Get immediate feedback about your builds and never lose a failing build again! Full documentation at docs.readthedocs.io/en/stable/build-notifications.html
-
Read the Docs reposted
EthicalAds
@ethicaladsio
We did a ProductHunt release to celebrate going v1.0 with our new ML-powered contextual targeting that targets based on page content, not who the user is. #privacy #advertising
www.producthunt.com/posts/ethicalads -
Read the Docs
@readthedocs
Excited about the 1.0 release of the open source code that powers ads on our site. We worked to build a privacy-first ad network targeting devs that doesn't do any user tracking and uses no cookies. We have Product Hunt & Show HN posts up, if you want to ask us any questions. π’
Eric Holscher
@ericholscher
Excited about the "1.0" release of our ad server code. This is the version that introduces ML modeling to build better ad targeting based only on the content of the pages we're serving. This is the groundwork for building really good ad targeting in a privacy-first way. π
EthicalAds
@ethicaladsio
We did a ProductHunt release to celebrate going v1.0 with our new ML-powered contextual targeting that targets based on page content, not who the user is. #privacy #advertising
www.producthunt.com/posts/ethicalads -
Read the Docs reposted
SciPyConf
@SciPyConf
wow new @readthedocs page on RTD for Science looks great!
docs.readthedocs.io/en/latest/science.html
with examples, a tutorial on Jupyter Book (from @ExecutableBooks) and shouts out to @matplotlib and friends
Read the Docs
@readthedocs
Our August updates:
* We made a docs page that talks about scientific use of RTD: docs.readthedocs.io/en/latest/science.html
* We have a new GH action to add a link to the PR preview of your docs
* Improved invites to become a maintainer of a project
Full details: blog.readthedocs.com/newsletter-august-2022/ -
Read the Docs
@readthedocs
Our August updates:
* We made a docs page that talks about scientific use of RTD: docs.readthedocs.io/en/latest/science.html
* We have a new GH action to add a link to the PR preview of your docs
* Improved invites to become a maintainer of a project
Full details: blog.readthedocs.com/newsletter-august-2022/ -
Read the Docs
@readthedocs
Sunday, we celebrated 6c38e6c0, the very first commit to Read the Docs! π
From a humble hackathon start, 12 years and 19327 commits and 424 contributors have been added!
There's a lot of pieces of the cake π° to share with everyone who helped out!
github.com/readthedocs/readthedocs.org/commit/6c38e6c0Post not available here, view on X
Read the Docs
@readthedocs
π° to the founding team (@bobbygrace, charlesleifer.com, & @ericholscher) for their vision and the Django community that invested their time to get this project going back in 2010. Doing the Django Dash & adding the first documentation projects to the platform.
Read the Docs
@readthedocs
π Happy Birthday everyone from the Read the Docs team.
Our birthday wishes are: Even more awesome documentation projects π But we also appreciate if you have a look at our page about sustainability and how we got this far β€οΈπ
readthedocs.org/sustainability/ -
Read the Docs
@readthedocs
What documentation tools would you love to see working on Read the Docs? Let us know in this thread π
We are experimenting with support for new documentation tools, and we hope to bring Read the Docs to more communities! -
Read the Docs
@readthedocs
Today we want to highlight the documentation of @poliastro_py and some of its nice things that called our attention! βpoliastro is an open source (MIT) pure Python library for interactive Astrodynamics and Orbital Mechanics...β
docs.poliastro.space/en/stable/
π€ (small) π§΅Post not available here, view on X
Read the Docs
@readthedocs
Pretty nice split of pages following the concepts behind DiΓ‘taxis (diataxis.fr) to find out immediately what you are looking for! Split in these sections: Tutorials, How-To guides, Reference, Background, Links βοΈ
Read the Docs
@readthedocs
That's the end of the π§΅. Did you like it? You have all this power at your hands! We are here, happy to help you host your amazing documentation on Read the Docs, readthedocs.org!
-
Read the Docs reposted
Maksudul Haque Saad
@saad_mk11
This was my @Google Summer of Code (#gsoc) project with @readthedocs back in 2019. π
Read the Docs
@readthedocs
Take a quick look at this video and learn "How to enable the Pull Request builder" in your projects. It will allow your team to review documentation changes in a much better and simple way!
-
Read the Docs
@readthedocs
Take a quick look at this video and learn "How to enable the Pull Request builder" in your projects. It will allow your team to review documentation changes in a much better and simple way!
Read the Docs
@readthedocs
You can read more about the Pull Request builder in our docs as well:
docs.readthedocs.io/en/stable/pull-requests.html -
Read the Docs
@readthedocs
Requiring installing dependencies with Poetry on Read the Docs? That's not an issue anymore! Use the config "build.jobs" to execute Poetry and install all your package dependencies. Check out this example!
Read the docs at docs.readthedocs.io/en/latest/build-customization.html -
Read the Docs
@readthedocs
Hosting your project's documentation with #docsifyjs has never been so easy! You can now do it on Read the Docs with minimal configuration. Check the docs at docs.readthedocs.io/en/latest/build-customization.html and take a look at this live example: test-builds.readthedocs.io/en/docsify/
-
Read the Docs
@readthedocs
Did you know that our build customization improvements now allow you to use any package manager you need to build your docs? Poetry? mamba? PDM? pipenv? They all work great! We won't tell you which one to use though π€«
docs.readthedocs.io/en/latest/build-customization.html -
Read the Docs
@readthedocs
Would you like to have a nicer homepage in your docs but you are not a CSS π₯·? Don't worry, take a look at @ubernauten documentation at manual.uberspace.de and see how 2 simple images in the right place can make a huge difference. Get inspired!
-
Read the Docs
@readthedocs
Did you know that Read the Docs supports overriding the full build process? Now you know π
This is a beta feature that we're excited about and want people to experiment with it. Now you can run Pelican in just a few lines of YAML. Check the docs at docs.readthedocs.io/en/latest/build-customization.html -
Read the Docs
@readthedocs
π our latest newsletter:
* A wonderful new set of example projects for users to get started quickly.
* Links to π― docs projects
* Support for integrating our flyout menu in themes
* Jupyterbook support in our hoverxref extension
* Lots more!
blog.readthedocs.com/newsletter-july-2022/ -
Read the Docs
@readthedocs
Today we want to highlight the "setuptools" docs and some nice features from it!
βSetuptools is a fully-featured, actively-maintained, and stable library designed to facilitate packaging Python projects.β
Check out their documentation at setuptools.pypa.io
π€ (small) π§΅Post not available here, view on X
Read the Docs
@readthedocs
They use the Furo theme, which looks beautiful and has many nice features (see pradyunsg.me/furo/). It is also well-integrated with Read the Docs, showing the flyout at the bottom left below the navigation bar.
Read the Docs
@readthedocs
That's the end of the π§΅. What are those small features you are proud of from your documentation? Share them with us, and we might highlight them in a future thread!
-
Read the Docs
@readthedocs
Today we found the documentation of "disnake" and we think it's pretty awesome! π
"disnake is a modern, easy to use, feature-rich, and async-ready API wrapper for Discord"
Check it out at docs.disnake.dev
We want to highlight some things we love from it.
π€ (small) π§΅
Read the Docs
@readthedocs
They have a custom extension, "atrtibutetable", that lists all the attributes and methods of a class. Useful to have an immediate overview about what's available without scrolling too much.
Read the Docs
@readthedocs
API reference combined with "sphinx-hoverxref" (sphinx-hoverxref.readthedocs.io) extension increases the power to another level. You can immediately get the context or the definition of a keyword without jumping into another completely different page.
Post not available here, view on X
Read the Docs
@readthedocs
"[source]" links point directly to the GitHub repository πͺ. It uses "sphinx.ext.linkcode" (www.sphinx-doc.org/en/master/usage/extensions/linkcode.html) with a custom "linkcode_resolve" Python function (github.com/DisnakeDev/disnake/blob/7853da70b13fcd2978c39cβ¦)
Read the Docs
@readthedocs
That's the end of the π§΅. What are those small features you are proud of from your documentation? π Share them with us!
-
Read the Docs reposted
humitos
@reydelhumo
Sphinx 6.x is removing jQuery dependency. How do you think extensions and themes that depend on jQuery should include it in a clean way?
I opened an issue to talk about this at github.com/sphinx-doc/sphinx/issues/10608
Do you have ideas? Thanks! -
Read the Docs
@readthedocs
We have just shipped our June newsletter, where we noted:
* adding a new member of the team, @benjaoming
* shipping beta support for fully customized build commands
* Nicer cancelled build UX
* Updates to some of our Sphinx extensions
blog.readthedocs.com/newsletter-june-2022/ -
Read the Docs reposted
humitos
@reydelhumo
Tomorrow, I'm traveling βοΈ to Vilnius π±πΉ to attend at @PyConLT πͺ
Say "Hi" and let's talk about Python π, @readthedocs π and all in between π¨βπ» -
Read the Docs
@readthedocs
Have you ever wanted to document your Javascript code with "jsdoc" and Sphinx? You can do that on Read the Docs!
Read more about how to customize your builds at docs.readthedocs.io/en/stable/build-customization.html
Read the Docs
@readthedocs
You can check out an example of this live in our test-builds repository:
* Github: github.com/readthedocs/test-builds/tree/jsdoc/docs
* RTD: test-builds.readthedocs.io/en/jsdoc/ -
Read the Docs
@readthedocs
A great write up that dives into the details of generating API docs with Sphinx. Thanks to @abey79 for putting in the work to write this up after figuring it out!
Antoine Beyeler
@abey79
Despite #sphinx ubiquity in the #python world, it is surprisingly hard to produce nice looking and functional API reference docs, with cross-ref'd summaries and proper TOC support.
I spent days on this for #vsketch, and wrote a tutorial with my findings:
bylr.info/articles/2022/05/10/api-doc-with-sphinx-autoapi/ -
Read the Docs
@readthedocs
We have just shipped out May newsletter. The big features:
π± We have shipped our CDN with instant cache purging for our Business users
π± More on user-defined build jobs
π± 404 tracking
π± Ubuntu 22.04 on builders
π± and lots more π³
blog.readthedocs.com/newsletter-may-2022/ -
Read the Docs
@readthedocs
We are happy to announce that projects can now select Ubuntu 22.04 LTS to build their docs. Enable this with `build.os: ubuntu-22.04` in your configuration file.
For more info (and copyable code examples) see our docs: docs.readthedocs.io/en/latest/config-file/v2.html -
Read the Docs
@readthedocs
Our servers are now running on Python 3.10 and Ubuntu 22.04 LTS. Running our platform on the latest releases! π
-
Read the Docs reposted
Chris Holdgraf
@choldgraf
You can now host #jupyterbook on @readthedocs! The next version of the official docs does this, and we put together a quick page showing how:
jupyterbook.org/en/latest/publish/readthedocs.html -
Read the Docs
@readthedocs
We shipped docs for one of our most-requested features: user-defined build jobs! We're excited to already see users adapting our platform for tools like Poetry & Doxygen. Learn more in our docs on the topic with some examples to get you started:
docs.readthedocs.io/en/latest/build-customization.html -
Read the Docs
@readthedocs
We've just released our April newsletter, which marks our 1 year newsletter anniversary. π This issue talks about a few new features, some dependency issues we've struggled with, and the new job that we're hiring for!
Check it out: blog.readthedocs.com/newsletter-april-2022/ -
Read the Docs
@readthedocs
We are looking for a new person to join our team! We're hiring for a product-focused application developer; someone who has opinions on how our product should work, and can help improve it!
Lots more details in the full job description: blog.readthedocs.com/job-product-developer/ -
Read the Docs
@readthedocs
Just a warning to folks in the Python docs ecosystem. It looks like the latest version of jinja (which deprecated features properly) has broken the latest mkdocs & sphinx before 4.0. You can fix this by pinning `jinja2<3.1.0` in your requirements:
docs.readthedocs.io/en/latest/guides/reproducible-builds.β¦
Read the Docs
@readthedocs
We also realize we need to update our guide to fully pin the dependencies for versions of tools using something like pip-tools. It's a bit more complicated, but will stop issues with transitive dependencies (like jinja2 in this case). A good guide here:
pip-tools.readthedocs.io/en/latest/
Read the Docs
@readthedocs
More details on the issue here:
* github.com/mkdocs/mkdocs/issues/2799
* github.com/sphinx-doc/sphinx/issues/10291 -
Read the Docs
@readthedocs
β οΈ GitHub is deprecating the Git protocol (URLs that start with git://) on March 15th.
Make sure to update the URLs of your dependencies or submodules that make use of the Git protocol,
so that builds keep working after March 15th.
More info on our blog:
blog.readthedocs.com/github-git-protocol-deprecation/ -
Read the Docs
@readthedocs
Many people are more affected by war in Ukraine than we are at Read the Docs. However, we want to be transparent about what the invasion means for us and voice our support for Ukraine: blog.readthedocs.com/2022-war-in-ukraine/
-
Read the Docs reposted
Isaac Levin
@isaacrlevin
Learn about how @readthedocs uses @elastic #elasticsearch to power the search across all the documentation there. Really great stuff!
www.youtube.com/watch?v=JGRmhQLYN3o -
Read the Docs reposted
Daniel Woste
@DanWos
I just have released a small, helpful tool to compare the performance of different #sphinxdoc build setups.
sphinx-performance.readthedocs.io
Thanks to the great rich lib by @willmcgugan, it also looks amazing for a CLI tool.
#docascode -
Read the Docs
@readthedocs
Our February newsletter is out:
* Our SSL configuration for our Commercial users is live
*Juan Luis has left as our dev advocate, and we'll be hiring again soon for a product-focused Python dev
* We rolled out fixes for our spam filtering & BitBucket
blog.readthedocs.com/newsletter-february-2022/ -
Read the Docs
@readthedocs
We are thrilled to support @tk0miya on GitHub Sponsors in appreciation for all the work he does to maintain #sphinxdoc. After having five major releases in 2021, we hope to see more and better functionality, more extensions, more themes, and a more diverse ecosystem! π
-
Read the Docs reposted
Documatt
@documattcom
Me when I found that my Sphinx extension gitlab.com/documatt/sphinxcontrib-constdata has been featured in @readthedocs blog
-
Read the Docs
@readthedocs
Sphinx 4.4 is out, and other #sphinxdoc extensions got new releases too! We made an abridged summary in our latest blog post: blog.readthedocs.com/sphinx-4-4-release-other-ecosystem-nβ¦ and you can read some highlights here π§΅
Post not available here, view on X
Read the Docs
@readthedocs
sphinxcontrib-constdata 1.0 by @documattcom allows documentation writers to easily load data stored in CSV, JSON, and YAML files - useful for UI labels and other configuration values x.com/documattcom/status/1479109313079566348
π
Documatt
@documattcom
Late to the party, but my most favorite extension is my own constdata documatt.gitlab.io/sphinxcontrib-constdata - that stops hard-coding values in docs. Released today :-)
Read the Docs
@readthedocs
Finally, the @executablebooks project is working on several exciting things around MyST, including the upcoming MyST-Parser 0.17 release and direct integration with Jupyter notebooks x.com/choldgraf/status/1485666900784730112
π
Chris Holdgraf
@choldgraf
The @ExecutableBooks and @ProjectJupyter folks are working on some pretty nifty integrations with MyST Markdown and Jupyter Lab
-
Read the Docs
@readthedocs
Excellent write-up on how to publish your Jupyter Book project on Read the Docs! βπ x.com/amoroso/status/1484194864736747521
-
Read the Docs
@readthedocs
Faster creation of corporate custom domains, documentation improvements, more privacy: read our January newsletter blog.readthedocs.com/newsletter-january-2022/
-
Read the Docs
@readthedocs
Sphinx and Markdown around the world in 2021 πππ with special mention to @ExecutableBooks. Read our new blog post! blog.readthedocs.com/sphinx-markdown-2021/
-
Read the Docs
@readthedocs
Document all the things π Happy new year 2022!
π©βπ» Paige Bailey
@DynamicWebPaige
"Well-maintained READMes, guides, and repos can result in as much as a 50% increase in productivity.
Meanwhile, automation was found to contribute as much as 43% to improvements in productivity within proprietary dev environments and 27% in OSS projects."
octoverse.github.com -
Read the Docs
@readthedocs
β οΈ If your Read the Docs project is failing to build with a `No module named 'setuptools._distutils'` error, please have a look at the instructions here: github.com/readthedocs/readthedocs.org/issues/8775
tl;dr: You need to cap `setuptools<60.0` in your project. -
Read the Docs
@readthedocs
We're seeing some connectivity issues to our hosting provider. We're looking into it and taking steps to work around issues.
Read the Docs
@readthedocs
Our connectivity seems to be coming back online, and sites should be operational again. Just a reminder that you can always see our real-time site status via our status page: status.readthedocs.com
-
Read the Docs
@readthedocs
Customizable webhooks, improved audit logs on Corporate, documentation improvements, and more: read our December newsletter β blog.readthedocs.com/newsletter-december-2021/
-
Read the Docs
@readthedocs
myst-parser 0.16.0 ships
β¬οΈ full compliance with the CommonMark v0.30 spec
β¨ support for field lists (paving the way to MyST docstrings)
π improved table rendering
π§ docutils-only mode
Start using Markdown in #sphinxdoc today! pypi.org/project/myst-parser/0.16.0/ Thanks @ExecutableBooks! -
Read the Docs reposted
Steve Piercy @stevepiercy@fosstodon.org
@steve_piercy
myst_parser - write rst or md, who cares?
sphinx_copybutton - copy code with a button
sphinx.ext.autodoc - doc your API
sphinx.ext.intersphinx - link to external docs
sphinxcontrib.spelling - spellchecker
sphinxext.opengraph - SEI -
Read the Docs reposted
Eric Holscher
@ericholscher
I like data templates. A nice abstraction for building data driven templates: sphinxcontribdatatemplates.readthedocs.io/en/latest/
-
Read the Docs reposted
Daniel Woste
@DanWos
Sphinx-Panels. Cards, drop-downs, grids, tabs. Great to get a more "website" look for your content.
sphinx-panels.readthedocs.io/en/latest/ -
Read the Docs
@readthedocs
Found a few useful #sphinxdoc extensions we did not know on this @github topic github.com/topics/sphinx-extension?o=desc&s=updated
What is your favourite Sphinx extension you think people should know more about? -
Read the Docs
@readthedocs
Announcing Embed API v3 and sphinx-hoverxref 1.0 π£
blog.readthedocs.com/embed-api-v3/
(Do you want to receive these updates on your email? Subscribe to our newsletter! landing.mailerlite.com/webforms/landing/p8b7z2) -
Read the Docs
@readthedocs
Powerful figures from the State of DevOps 2021 report: quality documentation improves team performance!
writerside
@onwriterside
"Documentation quality predicts teams
success at implementing technical practices.
These practices in turn predict improvements to
the systemβs technical capabilities such as
observability, continuous testing and deployment
automation- State of DevOps 2021 jb.gg/devops -
Read the Docs
@readthedocs
Save the date! π Our colleague @juanluisback will be presenting a tutorial on Sphinx, Markdown, and Read the Docs at @scipyla (in Spanish)
SciPy Latin America
@ScipyLA
Β‘Por fin es hora de dar a conocer nuestro programa!
Β‘Conozca mΓ‘s sobre las charlas y tutoriales que integrarΓ‘n la Conferencia Scipy Latin America 2021!
EntΓ©rate del detalle de los horarios aquΓ:
conf.scipy.lat/es/grade-programacao/
#scipy #scipylat #python -
Read the Docs reposted
Claudio Jolowicz
@cjolowicz
They recently introduced a new βbuild\.toolsβ setting where you can select Python 3.10. blog.readthedocs.com/new-build-specification/
-
Read the Docs reposted
Tom Christie
@starletdreaming
Seeing quite a few successful collaboratively funded OSS stories since back then.
Funded fellowship positions on Django, which never used to exist. Developer in residence position at PSF. Super impactful community-minded businesses like @getsentry and @readthedocs...
Eric Holscher
@ericholscher
Brings me back to the winter I spent in Thailand in 2014, when RTD was bringing in around $1k in donations. It was the first time I'd ever been able to live off my open source work, in a very frugal way, but it was a real milestone to the rest of the @readthedocs story. π΄π
-
Read the Docs
@readthedocs
We just launched a new custom domain configuration on readthedocs.org with stricter DNS checks on custom hostnames. If you are seeing any issues, please confirm your DNS configuration matches our docs, then reach out to support if needed: docs.readthedocs.io/en/latest/custom_domains.html
-
Read the Docs
@readthedocs
Read the Docs now supports Jupyter Book projects! π Read our announcement here blog.readthedocs.com/jupyter-book-read-the-docs/
Thanks to the @ExecutableBooks folks for all the work! -
Read the Docs
@readthedocs
It is always a pleasure to work with the @ExecutableBooks team! We are excited about Jupyter Book projects finally being supported on Read the Docs. Blog post coming shortly, in the meanwhile have a look at the official documentation:
jupyterbook.org/publish/readthedocs.html -
Read the Docs reposted
Steve Piercy @stevepiercy@fosstodon.org
@steve_piercy
We used rst-to-myst (github.com/executablebooks/rst-to-myst) to convert from reST to MyST syntax 356 pages of our @Plone Training documentation (training.plone.org/5/) for @ploneconf.
-
Read the Docs
@readthedocs
We completed the Read the Docs tutorial, deployed some quality of life improvements on the platform, and more: read our November newsletter blog.readthedocs.com/newsletter-november-2021/
-
Read the Docs
@readthedocs
Have you experienced build failures on your documentation recently, in the form of cryptic errors referencing Sphinx and docutils? In this post we explain what is happening, and how you can fix it blog.readthedocs.com/build-errors-docutils-0-18/
-
Read the Docs
@readthedocs
Our colleague @juanluisback will be presenting the tutorial "Document your scientific project with Markdown, Sphinx, and Read the Docs" at #pydataglobal2021. See you there!
PyData
@PyData
π’#pydataglobal2021 is exactly 2 weeks awayπ’
We want to dedicate a thread to all the amazing events coming up, if you haven't registered tickets yet do so with the link below, you don't want to miss out! (1/7)
pydata.org/global2021/tickets/ -
Read the Docs
@readthedocs
You can now use a new build image based on Ubuntu 20.04 with Python 3.10 and support for Node, Rust, and Go. Read more in our blog: blog.readthedocs.com/new-build-specification/
-
Read the Docs
@readthedocs
Python 3.10 is available, and you can already use it on Read the Docs! Use
build:
os: ubuntu-20.04
tools:
python: "3.10"
in your `.readthedocs.yaml`, and ship those docs π
docs.readthedocs.io/en/latest/config-file/v2.html -
Read the Docs
@readthedocs
New support for customizable Python, Node.js, Rust, and Golang versions, security logs on the dashboard UI, a new onboarding process, and more: read the October edition of our monthly newsletter
blog.readthedocs.com/newsletter-october-2021/ -
Read the Docs
@readthedocs
Do you need this for your project? Stay tuned, more details coming soon! x.com/stevejpurves/status/1445341917143764995
-
Read the Docs reposted
PyCon EspaΓ±a - π¦ @es.pycon.org π¦
@PyConES
ΒΏA que os gusta que los proyectos estΓ©n bien documentados? El sΓ‘bado @juanluisback nos enseΓ±arΓ‘ a crear fΓ‘cilmente la documentaciΓ³n nuestros propios proyectos usando MyST, Sphinx y @readthedocs 2021.es.pycon.org
-
Read the Docs
@readthedocs
Brace yourselves! sphinx-rtd-theme 1.0.0 is officially out π pypi.org/project/sphinx-rtd-theme/1.0.0/
Install it with `pip install "sphinx-rtd-theme~=1.0.0"` or upgrade with `pip install -U sphinx-rtd-theme`
See blog.readthedocs.com/theme-release-100rc1/ for extra context
Read the Docs
@readthedocs
Sphinx theme release 1.0.0rc1, our brand new tutorial, better private version sharing, and more: read the September edition of our monthly newsletter blog.readthedocs.com/newsletter-september-2021/
-
Read the Docs
@readthedocs
Sphinx theme release 1.0.0rc1, our brand new tutorial, better private version sharing, and more: read the September edition of our monthly newsletter blog.readthedocs.com/newsletter-september-2021/
-
Read the Docs
@readthedocs
The first release candidate of version 1.0.0 of our Sphinx theme is out! π₯ Read more about what's new, what's ahead, and how you can help test it:
blog.readthedocs.com/theme-release-100rc1/ -
Read the Docs reposted
Simon Willison
@simonw
This is the first time I've configured sphinx-autodoc for a project, so I wrote up a detailed TIL of the steps it took to get this working, including how I got them to build on @readthedocs til.simonwillison.net/sphinx/sphinx-autodoc
-
Read the Docs
@readthedocs
We have a new colleague, our #sphinxdoc tutorial is public, Python 3.10 beta in our images, and more: read the latest edition of our monthly newsletter (now with the correct embed) blog.readthedocs.com/newsletter-august-2021/
-
Read the Docs
@readthedocs
We have a new colleague, our #sphinxdoc tutorial is public, Python 3.10 beta in our images, and more: read the latest edition of our monthly newsletter blog.readthedocs.com/newsletter-august-2021/
-
Read the Docs reposted
Carol Willing
@WillingCarol
Thanks @ericholscher @readthedocs @cziscience! Hey @SciPyConf folks, you may be interested in this guide. Great content and love that multiple solutions were included. Bravo!
Eric Holscher
@ericholscher
Lots of work went into this guide, with lots of feedback from folks in the Jupyter ecosystem. Hopefully it provides a good starting point for getting started with Jupyter & Sphinx.
Read the Docs
@readthedocs
Do you want to use Jupyter notebooks in your Sphinx documentation and don't know where to start? Are you looking for ways to embed your interactive widgets, or generate example galleries? What about alternative notebook formats? Check out our new guide:
docs.readthedocs.io/en/stable/guides/jupyter.html -
Read the Docs
@readthedocs
Do you want to use Jupyter notebooks in your Sphinx documentation and don't know where to start? Are you looking for ways to embed your interactive widgets, or generate example galleries? What about alternative notebook formats? Check out our new guide:
docs.readthedocs.io/en/stable/guides/jupyter.html -
Read the Docs
@readthedocs
In our freshly published July newsletter, you will find our company highlights, what new features we have shipped during the past month (we have now a "rebuild this build" button π ), and what we will be working on for the coming weeks: blog.readthedocs.com/newsletter-july-2021/
-
Read the Docs
@readthedocs
You can read more about our latest @CZIScience update in this twitter thread. The initial work is detailed in our blog post here: blog.readthedocs.com/czi-grant-announcement/
Eric Holscher
@ericholscher
Feeling very appreciative of the @cziscience grant that we received to work on improving the Sphinx & RTD ecosystem. It has allowed us to move from barely getting our own work done, to actually being able to meaningfully contribute back.
-
Read the Docs
@readthedocs
Learn more about Read the Docs directly from its team members: check out this summary of our appearances in the media during the first half of 2021
blog.readthedocs.com/behind-the-scenes-2021-1/ -
Read the Docs reposted
humitos
@reydelhumo
I'm happy that this finally happened! It's an amazing feature that I'm super proud of.
It took me lot of headaches to make it work for all the edge cases and many hours digging into Sphinx's code.
Read the Docs
@readthedocs
We released sphinx-hoverxref v0.6b1 with support for intersphinx. Read more in our blog:
blog.readthedocs.com/hoverxref-intersphinx/
#sphinxdoc #sphinxThis media couldn't be displayed. See it on the original post. -
Read the Docs
@readthedocs
A simple but great extension that we use a lot.
#writethedocs #sphinx
Chris Holdgraf
@choldgraf
New sphinx-copybutton released! Now with more intelligent copying behavior, and a better button UX
sphinx-copybutton.readthedocs.io/en/latest/ -
Read the Docs
@readthedocs
We released sphinx-hoverxref v0.6b1 with support for intersphinx. Read more in our blog:
blog.readthedocs.com/hoverxref-intersphinx/
#sphinxdoc #sphinxThis media couldn't be displayed. See it on the original post. -
Read the Docs
@readthedocs
Just a heads up, we're tuning the firewall on our Community doc domain (readthedocs.io) to help keep things functioning properly during any future DOS. Please let us know if you find any issues with our new configuration, it shouldn't impact real users requests.
-
Read the Docs reposted
Eric Holscher
@ericholscher
My talk at #upstreamoss is coming up in ~10 mins. It's free to watch if you're curious about the sustainability story around RTD -- just click the link below. The anxiety around virtual speaking is still real π±
explore.tidelift.com/upstream/main/session-eric-holscher -
Read the Docs
@readthedocs
We're currently mitigating some kind of DOS on our documentation serving. We are hoping to get it under control, but some functionality may be degraded.
Read the Docs
@readthedocs
Site should be fully functional again, sorry for the issues.
Read the Docs
@readthedocs
A DOS in one graph...π
-
Read the Docs reposted
Eric Holscher
@ericholscher
Excited to be speaking at @UpstreamOSS next week about bootstrapping a sustainable OSS project. This will cover the story of how @readthedocs went from 0 to 8 folks working on it full-time. #sustainoss #fundoss
upstream.live/speaker-2021/eric-holscher -
Read the Docs
@readthedocs
We've just published our June newsletter. It covers what is happening with the company, and the projects that the team is working on: blog.readthedocs.com/newsletter-june-2021/
-
Read the Docs
@readthedocs
Your project needs extra system libraries to build its documentation? Now you can specify them directly! Read more in our blog: blog.readthedocs.com/apt-packages/
-
Read the Docs
@readthedocs
We are pleased to share with you our May newsletter. Highlights: Ra is joining us as Account Manager for ads, we deprecated recommonmark in favor of MyST, upcoming new Sphinx tutorial, still looking for a Frontend Developer, and disabled FLoC on our site. blog.readthedocs.com/newsletter-may-2021/
-
Read the Docs
@readthedocs
Proud to see a number of RTD-hosted projects in the scientific ecosystem on this list. There were definitely folks from @NASAJPL among the millions browsing our docs over the past few years. Thanks to all the scientists doing this amazing work for showing the best of humanity.
Nat Friedman
@natfriedman
Congratulations to NASA for the first controlled, powered flight of an aircraft on another world!
And to the thousands of open source developers who helped make this happen: we put a beautiful new badge on your GitHub profile. π
github.blog/2021-04-19-open-source-goes-to-mars/ -
Read the Docs reposted
Mariatta π€¦
@mariatta
Just posted the fourth entry of my #opensourcediary video πΊ
In this session, I'm sharing my workflow for creating documentation project using Sphinx and then hosting it on @readthedocs
youtu.be/A2BWjFWorg8 via @YouTube -
Read the Docs
@readthedocs
We're thrilled to announce our monthly newsletter. This month @juanluisback is joining our team, giving us additional capacity for community updates. The newsletter talks about recent released features, struggles we're having, and plans for next month.
blog.readthedocs.com/newsletter-april-2021/ -
Read the Docs
@readthedocs
We have released 0.5.2 of our sphinx theme to work around issues with captions and other markup. If you are seeing odd markup issues that recently started, we recommend updating your theme version.
More info here: github.com/sphinx-doc/sphinx/issues/9001 -
Read the Docs reposted
humitos
@reydelhumo
Would you like to contribute to @readthedocs? Here is a quick n' simple step-by-step guide to setup your development instance: docs.readthedocs.io/en/stable/development/standards.html
-
Read the Docs
@readthedocs
Pretty cool to see where our name pops up. Thanks for the kind words @issackelly! π
-
Read the Docs reposted
EthicalAds
@ethicaladsio
Love the work that @daringfireball & @EFF are doing to raise the alarm over the new ad tracking that is coming. We agree we don't have to go from one invasive tracking regime to another. We opt out!
daringfireball.net/linked/2021/03/04/eff-google-floc -
Read the Docs
@readthedocs
We just updated our guide for using conda & Read the Docs. This is just the start of our improvements to support the scientific community, funded by the @cziscience grant that we're doing this year. Please let us know what other guides you'd like to see!
docs.readthedocs.io/en/latest/guides/conda.html -
Read the Docs reposted
Chris Holdgraf
@choldgraf
What is the best resource for folks to get started with Sphinx these days? I find the Sphinx docs to be pretty heavy-weight, and not well-suited for "getting started". Maybe @readthedocs or @ericholscher could recommend something?
-
Read the Docs reposted
Santos Gallegos
@stsewd
This March 9 I'll be giving a talk about how we use ES at @readthedocs for the Elastic San Diego community. Be the first one to know about the fancy features coming next, and what you can already do :D
community.elastic.co/events/details/elastic-san-diego-pre⦠-
Read the Docs reposted
EthicalAds
@ethicaladsio
We're hiring a part-time advertising account manager to help with publisher and advertiser relationships, content marketing, and documentation. Come help us create an ad network that doesn't track users across the web.
www.ethicalads.io/jobs/account-manager-part-time/ -
Read the Docs reposted
γ¦γγ¦γε»ηζ
ε ±ζεΈ«
@Kengo_TODA
Really awesome, thank you!
V3 API made my project useful, secure and stable. Now my users don't need to set password, 'cause token based auth works perfectly π
github.com/KengoTODA/readthedocs-action -
Read the Docs
@readthedocs
We are excited to announce that our API v3 has reached a stable release, and is now available for all Read the Docs users. More information is available in our blog post: blog.readthedocs.com/api-v3-stable/
-
Read the Docs
@readthedocs
The site is back up, and fully functional as of 4pm PST today.
We're now settling into our new home at AWS. Thanks to @AWSOpen for giving us credits! We're excited about all the new toys we have to play with :)
Read the Docs
@readthedocs
Reminder that Read the Docs Community (readthedocs.org) will be having a 4 hour maintenance window next Friday (Feb 12) at 1pm PST for a data center migration. Dashboard will be offline, but docs will continue to serve.
More on our blog: blog.readthedocs.com/aws-migration/ -
Read the Docs reposted
Pylons Project
@PylonsProject
The @PylonsProject donates about $250 per year to @ThePSF from running ethical ads on its projects' documentation hosted by @readthedocs.
We're not Visionary like Google, but we give 100% of our revenue. Do we get a gold star? -
Read the Docs
@readthedocs
Just a reminder that this maintenance will be happening today in ~4 hours. This should be a very low usage time, and docs will continue to be online. New builds and the online dashboard will not be available.
Read the Docs
@readthedocs
Reminder that Read the Docs Community (readthedocs.org) will be having a 4 hour maintenance window next Friday (Feb 12) at 1pm PST for a data center migration. Dashboard will be offline, but docs will continue to serve.
More on our blog: blog.readthedocs.com/aws-migration/ -
Read the Docs
@readthedocs
We have completed our downtime event and the site should be fully operational again.
Read the Docs
@readthedocs
Just a reminder that Read the Docs for Business (readthedocs.com) will be having a 2 hour maintenance window today at 5PM PST for a Database upgrade. Dashboard will be offline, but docs will continue to serve.
More on our blog: blog.readthedocs.com/rtd-business-downtime-feb-5/ -
Read the Docs reposted
Justin Dorfman
@jdorfman
This was a good one π§ βSustain Episode 66: @ericholscher of @readthedocs, Write The Docs, and @ethicaladsioβ
podcast.sustainoss.org/66 -
Read the Docs
@readthedocs
Just a reminder that Read the Docs for Business (readthedocs.com) will be having a 2 hour maintenance window today at 5PM PST for a Database upgrade. Dashboard will be offline, but docs will continue to serve.
More on our blog: blog.readthedocs.com/rtd-business-downtime-feb-5/
Read the Docs
@readthedocs
Reminder that Read the Docs Community (readthedocs.org) will be having a 4 hour maintenance window next Friday (Feb 12) at 1pm PST for a data center migration. Dashboard will be offline, but docs will continue to serve.
More on our blog: blog.readthedocs.com/aws-migration/ -
Read the Docs
@readthedocs
Just a reminder, we have 2 job postings currently available. We'd love to have you come work with us!
Read the Docs
@readthedocs
We're hiring a frontend dev with design skills. We're building a JS client for embedding docs, and you'll be the primary person on that project. There's also other design & UX improvements with RTD itself that will help users.
blog.readthedocs.com/job-frontend/
#hiring -
Read the Docs reposted
Read the Docs
@readthedocs
We're excited to announce that we're hiring for 2 positions to help us complete the @cziscience grant we were awarded for 2021. All roles fully remote, and flexible from 3-5 days a week. This is a chance to have meaningful impact on OSS for science.
blog.readthedocs.com/read-the-docs-is-hiring-q1-2021/ -
Read the Docs
@readthedocs
We're excited to announce that we're hiring for 2 positions to help us complete the @cziscience grant we were awarded for 2021. All roles fully remote, and flexible from 3-5 days a week. This is a chance to have meaningful impact on OSS for science.
blog.readthedocs.com/read-the-docs-is-hiring-q1-2021/
Read the Docs
@readthedocs
We're hiring a frontend dev with design skills. We're building a JS client for embedding docs, and you'll be the primary person on that project. There's also other design & UX improvements with RTD itself that will help users.
blog.readthedocs.com/job-frontend/
#hiring
Read the Docs
@readthedocs
We're hiring a developer advocate with docs skills. Interviewing the scientific software community to understand their documentation needs, then building & promoting tutorials & resources to improve documentation in that ecosystem.
blog.readthedocs.com/job-devrel/
#hiring -
Read the Docs reposted
Write the Docs
@writethedocs
Always worth highlighting the @divio documentation system. The best way to think about structuring software documentation: documentation.divio.com
#writethedocs #techcomm -
Read the Docs reposted
EthicalAds
@ethicaladsio
Another exciting month here. We just shipped our November newsletter. The highlights:
* A record-breaking month for publisher revenue
* Approval on the Acceptable Ads list
* Lots of reporting improvements
* We might be growing our team soon
More here:
www.ethicalads.io/blog/2020/12/ethicalads-newsletter-nove⦠-
Read the Docs reposted
humitos
@reydelhumo
I want to thanks @saad_mk11 publicly for all the help he is bringing to us in a big and tricky refactor we are doing on @readthedocs
I'm enjoying discussing to him about how to tackle this and make it work without downtime! -
Read the Docs reposted
Read the Docs
@readthedocs
We're excited to announce that we've received a $200,000 grant from @ChanZuckerberg to work on expanding the interoperability of scientific documentation. More details and a high-level overview in our blog post:
blog.readthedocs.com/czi-grant-announcement/
#writethedocs #readthedocs #fundoss -
Read the Docs
@readthedocs
We've investigating downtime causing by networking issues at our hosting provider. We're hoping to have things back up soon.
Read the Docs
@readthedocs
The site should be back up, we have mitigated the networking issues.
-
Read the Docs
@readthedocs
We're excited to announce that we've received a $200,000 grant from @ChanZuckerberg to work on expanding the interoperability of scientific documentation. More details and a high-level overview in our blog post:
blog.readthedocs.com/czi-grant-announcement/
#writethedocs #readthedocs #fundoss
Read the Docs
@readthedocs
This grant has two parts. Part 1 allows us to develop new software to improve the interoperability of scientific documentation, specifically building on our sphinx-hoverxref tool. You can see a demo of it here on a fork of the Python docs: cpython-ericholscher.readthedocs.io/en/sphinx-hoverxref/wβ¦
Read the Docs
@readthedocs
Part 2 allows us do advocacy work around the importance and value of documentation in the scientific community. This will build on existing guides & tutorials in our docs ecosystem, but also aggregate @writethedocs and @thegooddocs valuable resources: www.writethedocs.org/topics/
Read the Docs
@readthedocs
You can read the full details and get more information on how to follow along on our blog post: blog.readthedocs.com/czi-grant-announcement/
We'll be sharing updates here as we go, so stay tuned! -
Read the Docs reposted
Mackenzie Weygandt Mathis, PhD
@TrackingActions
ππ₯ Something worth celebrating: honored to receive funding from @cziscience to support @DeepLabCut in 2021!
Our post: www.mousemotorlab.org/deeplabcutblog/2020/11/18/czidlc
CZI post: chanzuckerberg.com/newsroom/czi-awards-4-7-million-for-opβ¦
An honor to share this space w/incredible tools like @matplotlib @readthedocs @pandas_dev et alπ₯³ -
Read the Docs
@readthedocs
We had a brief outage earlier today. We are still working with our hosting provider to get back to full capacity, but things should be mostly back up.
-
Read the Docs reposted
ΓΌlgen kΔ±lΔ±Γ§
@ulgenklc
I published a documentation and an API for my library using @readthedocs. having done this once, it is so satisfactory to see your work put together. now, I have 7 other modules to document as a leisurely activity
complex-contagions.readthedocs.io/en/latest/index.html -
Read the Docs
@readthedocs
We're excited about the progress expanding our ethical advertising approach to more sites. Follow along with our new project that has grown from the ads we started running 4 years ago to funding developers across many communities: www.ethicalads.io
EthicalAds
@ethicaladsio
We've released our latest newsletter with updates from September 2020. We're excited to see 30% more revenue going to our publishers, and plan to keep expanding the network. Lots more info in the full post:
www.ethicalads.io/blog/2020/10/ethicalads-newsletter-septβ¦
#sustainoss #fundoss -
Read the Docs reposted
EthicalAds
@ethicaladsio
We're excited to officially ship EthicalAds: a privacy-focused ad network for developers. We are working to make open source development more sustainable with ads that don't track you. You can read more and follow our story on our new blog: www.ethicalads.io/blog/2020/08/announcing-ethicalads/
#sustainoss -
Read the Docs reposted
EthicalAds
@ethicaladsio
Hello world!
www.ethicalads.io -
Read the Docs reposted
Eric Holscher
@ericholscher
We're getting a ton of inbound interest from publishers for our new ad network! We're working hard to get existing advertisers serving ads on these sites, but also looking for new advertisers to start out today. I'd love to get these OSS projects revenue ASAP. π #sustainoss
-
Read the Docs reposted
Eric Holscher
@ericholscher
Given the news that @codefundio is shutting down, we've moved up our timeline to accept publishers onto our EthicalAds network. We've served over 1 billion ads on @readthedocs, and now we're ready to expand to your site: www.ethicalads.io
#sustainoss #ethicalads
CodeFund | Try EthicalAds.io
@codefundio
We are saddened to announce that today we are shutting down the CodeFund ethical ad network. Thanks to everyone who participated and supported us! It was an amazing 3 years!!!
codefund.io -
Read the Docs
@readthedocs
We recently shipped a CDN across all of readthedocs.org, sponsored by @CloudFlare. We wrote up a bit more about how this works on our blog: blog.readthedocs.com/announcing-community-cdn/ -- we hope the site is faster for everyone!
-
Read the Docs
@readthedocs
We've just published our 2019 stats on our blog: blog.readthedocs.com/read-the-docs-2019-stats/ -- a bit late, but we wanted to continue our tradition of sharing this data every year since 2013.
#writethedocs #readthedocs #techcomm -
Read the Docs
@readthedocs
We have released v0.5.0rc1 of our theme. This is meant as a testing release before our final release of the theme. Give it a try and let us know if you have issues:
* `pip install sphinx-rtd-theme==0.5.0rc1`
* Changelog: sphinx-rtd-theme.readthedocs.io/en/latest/changelog.html
* Issues: github.com/readthedocs/sphinx_rtd_theme/issues -
Read the Docs reposted
Carol Willing
@WillingCarol
Great news for the science world who use #python and conda. Looking forward to trying out some of the new support @readthedocs
Read the Docs
@readthedocs
We have good news for people using conda and building scientific documentation! Now, we have bigger builders and better support for your projects. Check out our blog post at blog.readthedocs.com/better-conda-support/ and please give us a try again for your scientific projects. π
-
Read the Docs
@readthedocs
We blogged about a feature to help users to automate some tasks on new versions π€. Learn more about it on our blog & let us know what other tasks you would like to automate!
blog.readthedocs.com/automation-rules/ -
Read the Docs reposted
Read the Docs
@readthedocs
We have good news for people using conda and building scientific documentation! Now, we have bigger builders and better support for your projects. Check out our blog post at blog.readthedocs.com/better-conda-support/ and please give us a try again for your scientific projects. π
-
Read the Docs
@readthedocs
We have good news for people using conda and building scientific documentation! Now, we have bigger builders and better support for your projects. Check out our blog post at blog.readthedocs.com/better-conda-support/ and please give us a try again for your scientific projects. π
-
Read the Docs
@readthedocs
Read the Docs 4.1.7 is released and deployed today:
* We're now fully behind a @cloudflare CDN for docs
* We're auto-redirecting domains with https and custom domains to their proper canonical URL
* Lots of other small fixes
docs.readthedocs.io/en/latest/changelog.html -
Read the Docs
@readthedocs
Just a heads up to folks out there, we're doing a CDN test over the weekend on our `*.readthedocs.io` documentation domains. Things should hopefully be much faster; please let us know if you see any issues, or things are working better!
Read the Docs
@readthedocs
We're now rolling out a CDN test to all of our documentation on the community site. We'd love your feedback if things feel faster, especially if you're far away from the US east coast. Thanks so much to @Cloudflare for sponsoring our infrastructure costs on this project.
-
Read the Docs reposted
ioChem-BD
@ioChem_BD
#compchem #opendata #openscience #bigdata Learning about how ioChem-BD works is now easier than ever! Check our new @readthedocs documentation at:
docs.iochem-bd.org -
Read the Docs reposted
Chris Holdgraf
@choldgraf
Sphinx just released a new major version! ππ
pypi.org/project/Sphinx/3.0.0/
Sphinx is such a crucial and under-appreciated tool in the Python ecosystem, congrats to the devs and the broader @readthedocs community. -
Read the Docs
@readthedocs
Running a community conference and the plans had to change? Change of dates? Switched to online? Get the word out with a free Read the Docs community ad!
docs.readthedocs.io/en/latest/advertising/ethical-adverti⦠-
Read the Docs reposted
courtois-neuromod
@CNeuromod
We just released a first version of our documentation! docs.cneuromod.ca Still six months away from our first public data release, but this 2020-alpha release is accessible to team members for feedback. Huge thanks to @datalad and @readthedocs for being awesome tools.
-
Read the Docs reposted
yo yehudi stays away from humans! π³οΈβπ
@yoyehudi
I know I talk a lot about how much I love GSoC, but here's another reason: I thought "hmm, wouldn't it be nice if @readthedocs could automatically build PRs to the @intermineorg docs", googled it, and found out that a student had just implemented it! blog.readthedocs.com/building-docs-for-pull-requests/
-
Read the Docs
@readthedocs
We are working on a v3 of our REST API which adds a lot more functionality for managing your projects. We're hoping that you'll help us test it! More information in a quick blog post here: blog.readthedocs.com/api-v3-beta/
-
Read the Docs
@readthedocs
One of our cofounders, Eric Holscher, is on the Changelog podcast talking about our ethical approach to advertising. Excited to see more of the industry talking about the privacy issues with our current advertising ecosystem. #ethicalads
Changelog
@changelog
π₯ New episode of The Changelog!
π¬ OSCON 2019 Anthology
π« @ericholscher @ASpittel @hpdang @adamstac @jerodsanto
π #oss #culture #leadership
π changelog.com/podcast/358 -
Read the Docs reposted
Read the Docs
@readthedocs
Ever wondered how to make sure your docs rank well on search engines? Check out our SEO guide for technical documentation!
docs.readthedocs.io/en/latest/guides/technical-docs-seo-g⦠-
Read the Docs
@readthedocs
Ever wondered how to make sure your docs rank well on search engines? Check out our SEO guide for technical documentation!
docs.readthedocs.io/en/latest/guides/technical-docs-seo-g⦠-
Read the Docs
@readthedocs
Our second @googleoss GSOC project has also just shipped: Pull Request building. It's currently behind a feature flag because of the extra build resources required. More information on our blog: blog.readthedocs.com/building-docs-for-pull-requests/ -- Thanks to @saad_mk11 for the work on this project!
-
Read the Docs reposted
Anthony Johnson (@aj@ohess.org)
@agjhnsn
Happy birthday @readthedocs! π
Exactly 9 years ago, give or take a timezone, your first commit ever was recorded. 5 years ago this month, we formed a company to support you with all of our attention. Today, you help millions of people each week.
We're all very proud of you!π₯ -
Read the Docs
@readthedocs
We're excited to tell you about one of our @googleoss
Summer of Code projects from this year: improving our search with Search As You Type and lots more. Read about it on our blog: blog.readthedocs.com/improved-search-and-search-as-you-type/ -- Thanks @dojutsu_user for your work on this! -
Read the Docs
@readthedocs
π
Pycon Africa
@pyconafrica
To all our bronze sponsors @gofundme @realpython @WildfishLondon @weeklypython @reuvenmlerner @torchbox @AktechLabs @CaktusGroup @sikilabs @pyacademy @readthedocs from the bottom of our heart, thank you.
#pyconafrica #pyconafrica19 -
Read the Docs
@readthedocs
We've been having a spam attack and have deployed changes around DNS, user signups, and email sending. Email sending might still be delayed or not working, but everything else should be functioning. Let us know if you have any issues via GitHub Issues: github.com/readthedocs/readthedocs.org/issues
-
Read the Docs
@readthedocs
We seem to be having issues with our load balancer that is serving documentation. We're looking into it, and will update a status soon.
Read the Docs
@readthedocs
We have deployed some initial workarounds, we should be slowly coming back online.
-
Read the Docs
@readthedocs
We had our first ever team offsite this past April. It was the first time each of the members of our team had met each other. We wrote up a bit more about why we did it, and what we accomplished on our blog: blog.readthedocs.com/offsite-2019/
-
Read the Docs reposted
PyLatam
@PyLatam
‘‘Le damos la bienvenida a @readthedocs como patrocinador oficial de #pyconlatam19 !! ‘Muchas gracias por su apoyo!
-
Read the Docs
@readthedocs
How has building an advertising business without tracking people been going? Pretty darn well if you ask us. An update on our ethical ads approach:
blog.readthedocs.com/ad-funding-read-the-docs-whats-next/ -
Read the Docs
@readthedocs
We already help Python conferences around the world with our "community ads" as a way to give back. We also wanted to support this wonderful event after meeting some of the organizers at @pycon this year, especially since it's their first year. Best of luck with the conference!
Pycon Africa
@pyconafrica
We are happy to announce @readthedocs as a Bronze #sponsor of #pyconafrica 2019! π
Read the Docs is the largest open source documentation hosting service. A place to create a central platform for people to find documentations.
πabout.readthedocs.com?ref=app.readthedocs.org
#pyconafrica19 -
Read the Docs
@readthedocs
We're excited to have @dojutsu_user and @saad_mk11 as GSoC 2019 students this year! They will be spending their summers with us working on projects that make the UX of Read the Docs better: search autocomplete & a pull request doc builder. More details: summerofcode.withgoogle.com/organizations/6158414290354176/
-
Read the Docs
@readthedocs
Glad to see the Linux kernel docs looking so beautiful π www.kernel.org/doc/html/latest/ #readthedocs #writethedocs
-
Read the Docs
@readthedocs
We've released an updated and much better version of our YAML config file. You can now configure a lot more with it, and it makes it easier to manage your Read the Docs projects via Pull Requests. Great work by @stsewd
Read more here: blog.readthedocs.com/configuration-file-v2/ -
Read the Docs reposted
Uetke Com
@uetke
#documenting code should be mandatory. #python makes it super simple to build beautiful documentation and host it online for free. Learn how #sphinx and @readthedocs can help you help others.
www.pythonforthelab.com/blog/documenting-with-sphinx-and-β¦ -
Read the Docs
@readthedocs
Struggling to get your foot in the door? We have tips to help you land a developer interview based on dozens of interviews with hiring managers.
blog.readthedocs.com/tips-for-getting-a-developer-interview/
#hiring #tech #python #recruiting -
Read the Docs reposted
Cory LaViska
@claviska
Ethical Advertising by @readthedocs. Letβs have more of this in the world. docs.readthedocs.io/en/latest/advertising/ethical-advertiβ¦
-
Read the Docs
@readthedocs
We're excited that the @GoogleOSS Summer of Code project from last year by @fordsafwan has been deployed across all of Read the Docs. Our search infrastructure has been greatly improved, you can read more about the project and improvements on our blog.
blog.readthedocs.com/search-improvements/ -
Read the Docs
@readthedocs
We talked to dozens of hiring managers this month and wrote about the common themes we heard. If your company is hiring developers, we have tips to help you hire better.
blog.readthedocs.com/lessons-from-hiring-manager-interviews/ #hiring #tech #python #recruiting -
Read the Docs
@readthedocs
We've just deployed some new search infrastructure. Please test it out and let us know if there are any issues! The neatest thing is that we now support Elastic's query syntax: www.elastic.co/guide/en/elasticsearch/reference/current/qβ¦
-
Read the Docs
@readthedocs
Is your company hiring? Do you want to hire people who read the docs? We are in the early phases of launching a product to help with that.
readthedocs.org/sustainability/advertising/recruiting/ -
Read the Docs reposted
Eric Holscher
@ericholscher
Unreasonably proud of the @readthedocs team who has made this possible. @agjhnsn @djfische @reydelhumo @stsewd have been doing an amazing job building a sustainable open source project with a business model that we can be proud of. #sustainoss #positivepython #docsoritdidnthappen
Read the Docs
@readthedocs
For the 6th year, we're publishing our project and company stats. We do this to be open & transparent about more than just our source code. The post has more detail, but:
* 400M pageviews (+18%)
* $294k revenue (+35%)
* 3774 commits (+257%)!
blog.readthedocs.com/read-the-docs-2018-stats/
#sustainoss -
Read the Docs
@readthedocs
For the 6th year, we're publishing our project and company stats. We do this to be open & transparent about more than just our source code. The post has more detail, but:
* 400M pageviews (+18%)
* $294k revenue (+35%)
* 3774 commits (+257%)!
blog.readthedocs.com/read-the-docs-2018-stats/
#sustainoss -
Read the Docs
@readthedocs
Is your company recruiting? π» Read the Docs can help! Get your job posting in front of developers actively using the tech you are recruiting for. blog.readthedocs.com/hiring-developers-with-readthedocs/ #hiring #recruiting
-
Read the Docs
@readthedocs
Hold tight, friends! We're currently at capacity, working through a large backlog of build requests from GitHub. Project builds will be delayed and may timeout while we work to process these requests.
-
Read the Docs reposted
Pylons Project
@PylonsProject
We're seeking feedback on serving Ethical Ads on Pylons Project docs served by @readthedocs.
Please read and reply:
groups.google.com/forum/ -
Read the Docs reposted
CodeFund | Try EthicalAds.io
@codefundio
@readthedocs is amazing! They definitely set the bar of excellence for ethical advertising π we followed their lead with community advertising blog.readthedocs.com/community-ads-2018/
-
Read the Docs
@readthedocs
Do you run a community tech conference, non-profit, or a cash strapped open source project and you need to get the word out? We can help with our Community Ads program: blog.readthedocs.com/community-ads-2018/
-
Read the Docs
@readthedocs
Things went well and everything has been back online for about an hour. Let us know if you see any issues in the next few days!
Read the Docs
@readthedocs
A reminder that in 30 minutes we'll be going down for maintenance. Docs will continue to serve, but the dashboard will be offline while we transfer data centers. More information here: blog.readthedocs.com/azure-migration/
-
Read the Docs
@readthedocs
A reminder that in 30 minutes we'll be going down for maintenance. Docs will continue to serve, but the dashboard will be offline while we transfer data centers. More information here: blog.readthedocs.com/azure-migration/
-
Read the Docs reposted
Django Girls
@djangogirls
Read the Docs hosts documentation for the open source community. They became @djangogirls crowdfunding supporters by running a donation matching program for our campaign in March 2018. Thank you @readthedocs
π₯πΎπ©π¨π -
Read the Docs
@readthedocs
Today, we started redirecting traffic from http -> https for readthedocs.io domainsπ
If you encounter any issues, let us know in the issue tracker: github.com/rtfd/readthedocs.org/issues -
Read the Docs
@readthedocs
Read the Docs supports HTTPS on custom domains! Lots of folks asked about this at PyCon and now it's a reality. Thanks for all the help @Cloudflare. You can read more on our blog: blog.readthedocs.com/https-for-custom-domains/
-
Read the Docs
@readthedocs
We're migrating data centers, Rackspace to @Azure, next Saturday, August 18. We will have a maintenance window of 4 hours, starting 10:00am PDT (1:00pm EDT, 17:00 UTC). Doc sites will be up, but the site dashboard will be down. More info on our blog:
blog.readthedocs.com/azure-migration/ -
Read the Docs
@readthedocs
You're probably overwhelmed with "updates to our privacy policy" but in case you aren't, you can read about what the #gdpr means for us. π‘ blog.readthedocs.com/gdpr-what-it-means-for-readthedocs/ #privacy #privmas
-
Read the Docs
@readthedocs
An update on ad blocking: we have now been added to the Acceptable Ads list. This has returned around 55% of the lost revenue that we saw with ad blocking. More data available in the post: blog.readthedocs.com/ad-blocker-update/
-
Read the Docs
@readthedocs
Today we're happy to announce that we support signing up & logging in with GitHub, BitBucket or GitLab. Give it a try and let us know how it works for you.
blog.readthedocs.com/version-control-login/ -
Read the Docs
@readthedocs
We're written about one of the largest challenges in building Ethical Advertising: Ad blocking. This post covers the fallout from being blocked, and talks about our ideas for moving forward.
blog.readthedocs.com/ads-and-adblocking/
#sustainoss #adblock -
Read the Docs reposted
Eric Holscher
@ericholscher
Ethical Advertising Works: A write up of our thoughts on 2 years of ethical ads, and the next steps for us in exploring this way of funding open source: blog.readthedocs.com/ethical-advertising-works/ #sustainoss #ethics #ethicalads
-
Read the Docs reposted
Ignatia - Inge de Waard
@Ignatia
Great concept #ethicalads by @readthedocs Ads are transparent & not sold to 3 parties. Cfr newspaper ads on the Web. thx @bstarling_
-
Read the Docs
@readthedocs
We're glad to have helped this wonderful organization meet their fundraising goals! They have been a source of pride in the open source community, and we are happy to have done our small part to help them in their journey. #positivepython
Django Girls
@djangogirls
New blog post: Read the Docs joins as Django Girls Global Partner blog.djangogirls.org/post/171834511626
-
Read the Docs
@readthedocs
Thanks to everyone who gave money to @djangogirls with our $1,000 matching campaign. We raised $2,000 in under 24 hours!
With our match, they have $8,500. Help get them over $10,000 by the end of the week: www.generosity.com/community-fundraising/django-girls-fun⦠#codewithkindness #positivepython -
Read the Docs reposted
Eric Holscher
@ericholscher
I'm organizing a matching campaign for @djangogirls. Let's show how much we value their amazing work. @readthedocs is going to put up the first $1,000!
An amazing way to invest in the future of OSS. I hope other businesses in the ecosystem will join me. #positivepython -
Read the Docs reposted
Andrew Caya βοΈ
@AndrewSCaya
Many thanks to the great friends of the #oss community that make these projects possible! #opensource #php
@github @travisci @saucelabs @codeclimate @readthedocs
/cc @joomla @JoomlaDeveloper
Andrew Caya βοΈ
@AndrewSCaya
We are happy to announce the release of version 2.2.0 of the Simple Email Form module for @joomla. May our 10,000+ users find it useful! Enjoy!
joomla.unlikelysource.org -
Read the Docs
@readthedocs
We're released our 2017 stats post: blog.readthedocs.com/read-the-docs-2017-stats/
Quick stats:
* 338M page views
* 75M unique doc readers
* 77k projects
* 103k users
* 1058 commits
* $250,000 in revenue
Thanks to everyone in the community who has helped us make 2017 our most successful year yet! -
Read the Docs reposted
benjaoming - follow on ποΈ
@benjaoming
Working with multilingual documentation text, the combo of @crowdin @readthedocs and Sphinx+ReST syntax is such a win! Well done all!
-
Read the Docs
@readthedocs
Woo! Excited to be able to support diversity in the Python community via @pycascades, a wonderful regional conference in our home base of the Pacific Northwest. Looking forward to seeing folks there in a couple weeks!
-
Read the Docs reposted
Gio
@gdelgado
Ethical Advertising. π π π @readthedocs
docs.readthedocs.io/en/latest/ethical-advertising.html -
Read the Docs reposted
Erik Dahl
@DahlSailRunner
It's LIVE! My new course on @readthedocs with a Git-based workflow is live on @pluralsight !! www.pluralsight.com/courses/build-contribute-documentatio⦠Even includes setup of CI/CD with @VSTS !
-
Read the Docs reposted
Eric Holscher
@ericholscher
I'm ridiculously excited our sustainability efforts have started to pay off. We have been able to bring @reydelhumo on to work on @readthedocs, 4 days a week. It has been a huge lift in my spirits to expand the team. Feels like we can make real progress now, not just tread water.
-
Read the Docs
@readthedocs
π #ethicalads #sustainoss
mike
@funcitonretrun
hey @readthedocs I already found your site super useful, and then I found your advertising philosophy: docs.readthedocs.io/en/latest/ethical-advertising.html. love it
-
Read the Docs reposted
Erik Dahl
@DahlSailRunner
Just submitted the final content for my new @pluralsight course about documentation using Git workflows and @readthedocs ! Super excited to see this one go live!
-
Read the Docs reposted
Mike Mabey
@mkmabey
This is cool news: Linux Mint is moving their documentation to @readthedocs!
Linux Mint
@Linux_Mint
Monthly News β November 2017
blog.linuxmint.com?p=3442 -
Read the Docs
@readthedocs
We're looking for our Community Ad for November. Have an OSS project campaign you want to promote? We can help: docs.readthedocs.io/en/latest/ethical-advertising.html
-
Read the Docs reposted
Olamilekan
@__olamilekan__
I mean, virtually every Python library I've had to install has an @readthedocs page which makes things really awesome.
-
Read the Docs reposted
T-bone
@t_konch
Pretty sure I get a dopamine release just seeing a @readthedocs CSS styled page.
-
Read the Docs
@readthedocs
We've put up our September community ad, for @pycascades: www.pycascades.com -- Join us in Vancouver, BC; January 22-23!
-
Read the Docs reposted
Eric Holscher
@ericholscher
Happy to report that @readthedocs is at near-term sustainability with our Ethical Ads program (docs.readthedocs.io/en/latest/ethical-advertising.html). Quite a relief.
-
Read the Docs
@readthedocs
We wrote a final report on the @mozilla MOSS grant they kindly gave us a while back: blog.readthedocs.com/moss-final-report/ - Thanks for supporting OSS!
-
Read the Docs reposted
Read the Docs
@readthedocs
We're running a Community Ad for Mozilla's MOSS program, which helps fund open source: www.mozilla.org/moss/ -- Apply by July 31! #fundoss
-
Read the Docs
@readthedocs
We're running a Community Ad for Mozilla's MOSS program, which helps fund open source: www.mozilla.org/moss/ -- Apply by July 31! #fundoss
-
Read the Docs reposted
Read the Docs
@readthedocs
Check out this great Sphinx library to document your Javascript code: hacks.mozilla.org/2017/07/introducing-sphinx-js-a-better-β¦ -- From @ErikRose & @mozilla! #writethedocs
-
Read the Docs
@readthedocs
Check out this great Sphinx library to document your Javascript code: hacks.mozilla.org/2017/07/introducing-sphinx-js-a-better-β¦ -- From @ErikRose & @mozilla! #writethedocs
-
Read the Docs
@readthedocs
Weβre still recovering from an outage on our community site, but things are mostly back to normal. Updates here: github.com/rtfd/readthedocs.org/issues/2981
-
Read the Docs
@readthedocs
Both documentation and dashboard pages are down currently. Our provider is working through a widespread outage. Weβll be back soon!
-
Read the Docs
@readthedocs
We're going to start running ads on projects with Alabaster themes soon. More info on our blog: blog.readthedocs.com/ads-on-other-themes/
-
Read the Docs
@readthedocs
Glad to see GitHub and the Open Source community acknowledging the value and inclusive nature of Documentation: opensourcesurvey.org/2017/
-
Read the Docs
@readthedocs
With PyCon wrapped up, hereβs a look back at our sprints last week:
* 5 new contributors
* 38 merged pull requests
blog.readthedocs.com/pycon-2017/ -
Read the Docs
@readthedocs
If you are at the #pycon sprints, join us in room B114 to help work on Read the Docs!
-
Read the Docs
@readthedocs
New to Read the Docs as of yesterday: improved webhook management and bug fixes for Sphinx 1.5 support
blog.readthedocs.com/release-2017-05-12/ -
Read the Docs reposted
turbodbc
@turbodbc
After a long wait, there is proper #turbodbc documentation at @readthedocs: turbodbc.readthedocs.io/en/latest/
I already forgot how I managed before. -
Read the Docs
@readthedocs
Excited that @Uniregistry has joined us as a partner in our Ethical Advertising campaign: blog.readthedocs.com/ads-with-uniregistry/
Read the Docs
@readthedocs
.@Uniregistry They're kindly offering Read the Docs users 25% off a domain transfer or registration with the code `DOCS25`.
-
Read the Docs
@readthedocs
We have just released a new version of our theme, and upgraded Sphinx to 1.5.3 on default builds. Please let us know about any issues.
-
Read the Docs reposted
Travis Foundation
@travis_fnd
Ever used @readthedocs? This βMaintainer Storiesβ episode with @ericholscher about starting Read The Docs is great π www.youtube.com/watch?v=us_3IGG6leM
-
Read the Docs
@readthedocs
Starting this week, our default Python 3 version will be 3.5, and Python 3.6 is now available for testing as well!
blog.readthedocs.com/build-image-upgrade/ -
Read the Docs reposted
Carol Willing
@WillingCarol
"Documentation is Outreach." @ericholscher, I can't wait to see this on video. @writethedocs @readthedocs Enjoy @pyconcolombia
bonetti
@wbonett10
Pycon π¨π΄ #pyconco2017 @pyconcolombia ππΌ
-
Read the Docs reposted
David Puckett
@BrightRain
I like this
"We donβt track you...
Weβre doing newspaper advertising, on the internet..."
kudos @readthedocs -
Read the Docs reposted
Read the Docs
@readthedocs
On Monday this week, we had our first day with over 1 million pageviews in a single day. Thanks to everybody out there reading the docs!
-
Read the Docs
@readthedocs
On Monday this week, we had our first day with over 1 million pageviews in a single day. Thanks to everybody out there reading the docs!
-
Read the Docs reposted
Debookee
@debookee
Got it @marca56 Incredible how a nice documentation tool like @readthedocs gives you the motivation to do better docs.
-
Read the Docs reposted
PyCon Colombia
@pyconcolombia
the @readthedocs and @writethedocs co-founder @ericholscher at @pyconcolombia 2017. Few tickets left! www.eventbrite.co/e/pycon-colombia-2017-tickets-28642416238
-
Read the Docs reposted
Read the Docs
@readthedocs
Our 2016 stats: blog.readthedocs.com/read-the-docs-2016-stats/
* 252M (+48%) Pageviews
* 53.5K (+91%) Projects
* 18 (-50%) Committers
* Closer to sustainable ($) -
Read the Docs
@readthedocs
Our 2016 stats: blog.readthedocs.com/read-the-docs-2016-stats/
* 252M (+48%) Pageviews
* 53.5K (+91%) Projects
* 18 (-50%) Committers
* Closer to sustainable ($) -
Read the Docs reposted
Hoodie
@hoodiehq
πΆπ Dear Python / Sphinx Doc / @readthedocs friends. Can you help us with instructions to build our new docs locally? github.com/hoodiehq/hoodie/issues/660
-
Read the Docs
@readthedocs
We had some build queue issues overnight which are now resolved. Builds should be running normally shortly.
-
Read the Docs
@readthedocs
Heads up everyone! Weβve scheduled a database maintenance window Dec 22nd, 5-7pm PT. Docs will stay up but the dashboard will be unavailable
Read the Docs
@readthedocs
Just a reminder: you may notice problems building and trouble accessing the dashboard during our maintenance window later today
Read the Docs
@readthedocs
Heads up everyone! Weβve scheduled a database maintenance window Dec 22nd, 5-7pm PT. Docs will stay up but the dashboard will be unavailable
Read the Docs
@readthedocs
Things are now back to business as usual. If you notice any strange behavior, be sure to open a ticket on our issue tracker.
Read the Docs
@readthedocs
Heads up everyone! Weβve scheduled a database maintenance window Dec 22nd, 5-7pm PT. Docs will stay up but the dashboard will be unavailable
-
Read the Docs reposted
Colin Dixon
@colin_dixon
Awesome to see lots of @linuxfoundation projects moving to using Sphinx and @readthedocs
-
Post not available here, view on X
Eric Holscher
@ericholscher
.@mozilla I work with @readthedocs, where we host docs for the OSS ecosystem. More info/stats here: blog.readthedocs.com/read-the-docs-2015-stats/ #fundopensource
Read the Docs
@readthedocs
Check out the #fundopensource chat happening now with @mozilla. One of our maintainers @ericholscher is participating.
Eric Holscher
@ericholscher
.@mozilla I work with @readthedocs, where we host docs for the OSS ecosystem. More info/stats here: blog.readthedocs.com/read-the-docs-2015-stats/ #fundopensource
-
Read the Docs
@readthedocs
Announcing a (very) beta release of pydoc.io β our approach to autogenerating API docs for Python code: blog.readthedocs.com/announcing-pydoc-io/
-
Read the Docs reposted
Talk Python Podcast
@TalkPython
#84 Are we failing to fund Python's core infrastructure? with @dstufft @ewa_jodlowska @ericholscher @WillingCarol talkpython.fm/episodes/show/84/are-we-failing-to-fund-pytβ¦
-
Read the Docs
@readthedocs
Our ad for the next 2 days is the vote.org polling place locator: www.vote.org/polling-place-locator/ #votethedocs
-
Read the Docs
@readthedocs
Glad that our ads helped @subformapp it reach itβs Kickstarter goal. Great forward-looking design tool: www.kickstarter.com/projects/298226251/subform-a-modern-tβ¦ #ethicalads
-
Read the Docs reposted
PyCon Colombia
@pyconcolombia
We are thrilled @ericholscher co-founder of @readthedocs and @writethedocs is keynote speaker in our event.More info www.pycon.co
-
Read the Docs
@readthedocs
Excited to work with @getsentry, another open source company, as our first Ethical Advertising partner: blog.readthedocs.com/ads-with-sentry/
-
Read the Docs
@readthedocs
Help us build a business around advertising that doesnβt track you, doesnβt sell your data, and isnβt in your way: docs.readthedocs.io/en/latest/ethical-advertising.html
-
Read the Docs
@readthedocs
This is why weβre so happy to be building an ethical advertising model, in sharp contrast to Google. www.propublica.org/article/google-has-quietly-dropped-banβ¦
-
Read the Docs reposted
Titus Brown
@ctitusbrown
DIB Lab learning: sphinx and @readthedocs config and setup screencast. www.youtube.com/watch?v=R-gw7e_f_Jw
-
Read the Docs reposted
Eric Holscher
@ericholscher
Documentation is a wonderful way to contribute to open source. #writethedocs
-
Read the Docs
@readthedocs
In case you missed it, weβre running an ad reminding folks to register to vote this week: www.usa.gov/voter-registration-deadlines
-
Read the Docs
@readthedocs
Havenβt sold our ad space this week, so weβre running this ad to remind folks to vote: www.usa.gov/voter-registration-deadlines
-
Read the Docs
@readthedocs
Builds are currently queueing up, as maintenance is being performed on our build server storage. Docs are all still available though!
Read the Docs
@readthedocs
Builds should now be back to normal and any builds that were queued up should be processed.
-
Read the Docs reposted
Aymeric Augustin
@aymericaugustin
Iβm OK with (a) manually vetted (b) highly relevant (c) not obnoxious ads. Great pioneering work by @ericholscher.
Eric Holscher
@ericholscher
Funding Open Source with Marketing Money: ericholscher.com/blog/2016/aug/31/funding-oss-marketing-mβ¦ β My high level thoughts on funding OSS, and why Read the Docs has ads.
-
Read the Docs reposted
Eric Holscher
@ericholscher
Amazing work thats *so* timely. @nayafiaβs must-read paper on OSS sustainability: www.fordfoundation.org/library/reports-and-studies/roads-β¦
Summary: storify.com/Lukasaoz/open-source-infrastructure-white-paper -
Read the Docs reposted
Eric Holscher
@ericholscher
To folks who offered help, and I missed: docs.readthedocs.io/en/latest/contribute.html & github.com/rtfd/readthedocs.org/pull/2296/files has more info β please give feedback/etc.
-
Read the Docs reposted
Eric Holscher
@ericholscher
Wow, @berkerpeksag just submitted 10 PRβs on @readthedocs today β made me smile. Thank you!
-
Read the Docs
@readthedocs
Still working to restore service, hang in there!
Read the Docs
@readthedocs
All systems back to normal! We resolved doc hosting issues after a short while, dashboard access was just returned
Read the Docs
@readthedocs
Still working to restore service, hang in there!
-
Read the Docs
@readthedocs
Weβre currently looking into issues with our load balancers. Should be back to normal in short order.
Read the Docs
@readthedocs
All systems are back to normal! You may resume your reading.
Read the Docs
@readthedocs
Weβre currently looking into issues with our load balancers. Should be back to normal in short order.
-
Read the Docs reposted
Eric Holscher
@ericholscher
Super excited that @BruceEckel fixed a long-standing, super annoying to debug issue with @readthedocs at the #pycon2016 sprints. Thanks!
-
Read the Docs
@readthedocs
Come join us in room 254 at the #pycon sprints, weβre sprinting on bugs and documentation. Weβd love help updating our doc translations!
-
Read the Docs reposted
Eric Holscher
@ericholscher
If you're at #pycon2016 add your project to the list of docs on @readthedocs. We're right across from start up row.
-
Read the Docs reposted
Titus Brown
@ctitusbrown
Materials for #pytutproj at github.com/dib-lab/2016-pycon-tutorial/blob/master/README.md - walk through config for @droneio @codecov @readthedocs cc @camille_codon @luizirber
-
Read the Docs
@readthedocs
Come find our booth at #pycon2016 and add your project name to our list of users!
-
Read the Docs reposted
Mozilla
@mozilla
Only days left to apply for MOSS! Get funding & join #opensource projects like @discourse @readthedocs @BRO_IDS mzl.la/MOSSapplication
-
Read the Docs
@readthedocs
In case you missed it yesterday, project documentation is now served from subdomains on readthedocs.io: blog.readthedocs.com/securing-subdomains/
-
Read the Docs
@readthedocs
Starting today, docs will be served from subdomains on readthedocs.io! Donβt worry, we wonβt break your links! blog.readthedocs.com/securing-subdomains/
-
Read the Docs reposted
bigbluehat
@bigbluehat
"If your project is an open source project, you most certainly also lack funding." from @readthedocs advertising page...Sad & True
-
Read the Docs reposted
Write the Docs
@writethedocs
π Announcing presentations for our Portland conference, Prague dates, and a questionnaire π
www.writethedocs.org/conf/na/2016/news/announcing-presentβ¦
#writethedocs
#π²βπ -
Read the Docs
@readthedocs
About Advertising on Read the Docs Community Sites: blog.readthedocs.com/ads-on-read-the-docs/
-
Post not available here, view on X
Read the Docs
@readthedocs
@giorgiosironi @mvriel If there is a good way to export the API doc as JSON, we can support it in Sphinx via github.com/rtfd/sphinx-autoapi/
-
Read the Docs reposted
Eric Holscher
@ericholscher
Iβll be giving a tutorial at @pycon about how to document your code w/ Sphinx & @readthedocs β us.pycon.org/2016/schedule/presentation/1454/ #writethedocs
-
Read the Docs
@readthedocs
Read the Docs 2015 Stats: blog.readthedocs.com/read-the-docs-2015-stats/
Read the Docs
@readthedocs
In case you missed it, we published our stats from 2015.
Read the Docs
@readthedocs
Read the Docs 2015 Stats: blog.readthedocs.com/read-the-docs-2015-stats/
-
Read the Docs
@readthedocs
Site issues should now be fixed on rtd.org
-
Read the Docs
@readthedocs
Working on fixing a database issue, website & building documentation is currently down on rtd.org. Should be fixed soon.
-
Read the Docs
@readthedocs
Use RTD everyday? You can now support us monthly with Gold: readthedocs.org/accounts/gold/subscription/ β Help us make the site more sustainable over time.
-
Read the Docs reposted
Write the Docs
@writethedocs
Announcing ticket sales & call for proposals for Write the Docs NA 2016: www.writethedocs.org/conf/na/2016/news/cfp-tickets/ #writethedocs #techcomm
-
Read the Docs reposted
Alyssa Coghlan
@ncoghlan_dev
A nice end-of-year gift from @readthedocs for science & data analysis folks: conda is now supported for doc builds: docs.readthedocs.org/en/latest/conda.html
-
Read the Docs reposted
Podcast.__init__
@Podcast__init__
Documentation is an important part of software, that's why we interviewed @ericholscher about @readthedocs pythonpodcast.com/eric-holscher-documentation.html
-
Read the Docs
@readthedocs
Read the Docs was just awarded a grant for PyPI integration, as part of the first round of @mozilla's MOSS program: blog.readthedocs.com/rtd-awarded-mozilla-open-source-suppβ¦
-
Read the Docs
@readthedocs
Excited to see @letsencrypt bringing free SSL certs to the world. Read more about it: letsencrypt.readthedocs.org/en/latest/intro.html
-
Read the Docs reposted
Eric Holscher
@ericholscher
Went ahead and rendered the Swift documentation on @readthedocs, since Apple built it in Sphinx: apple-swift.readthedocs.org/en/latest/contents.html #swift #apple
-
Read the Docs
@readthedocs
Currently experiencing some more database issues. Access to the project dashboard should be resolved shortly.
-
Read the Docs
@readthedocs
Issues should now be resolved.
-
Read the Docs
@readthedocs
We're having some database issues which we are working to resolve. Should be fixed soon!
-
Post not available here, view on X
Read the Docs
@readthedocs
@petipandarou Any particular critique, other than "horrible"?
Read the Docs
@readthedocs
@petipandarou Would love a blog post or GitHub Issue that lays out ways to improve. Hard to see issues from the inside.
Read the Docs
@readthedocs
@petipandarou Also, perhaps this is a bit more useful β sphinx-tutorial.readthedocs.org/start/
-
Read the Docs reposted
SecureDrop
@SecureDrop
We just totally re-did our documentation with @readthedocs! Easier to navigate, searchable, and mobile-friendly: docs.securedrop.org
-
Read the Docs
@readthedocs
Read the Docs & Sphinx now support Markdown (Commonmark) β blog.readthedocs.com/adding-markdown-support/ β This is a new release, so please give us feedback.
-
Read the Docs reposted
Write the Docs
@writethedocs
π’ Write the Docs North America will be in Portland on May 22-24, 2016 π’
We're excited to see everyone again! More details soon. -
Read the Docs
@readthedocs
We have made our build processes more secure, read about it here: blog.readthedocs.com/securing-build-processes/
-
Read the Docs
@readthedocs
In case you missed it yesterday, here's our last year in review for Read the Docs: blog.readthedocs.com/state-of-the-docs-2015/
-
Read the Docs
@readthedocs
Here's a review of the last two months of work we did as part of our fundraiser: blog.readthedocs.com/report-july-2015/ and blog.readthedocs.com/report-august-2015/
-
Read the Docs
@readthedocs
We wanted to provide more insight into Read the Docs, so here is our State of the Docs, a year in review -- blog.readthedocs.com/state-of-the-docs-2015/
-
Read the Docs reposted
Eric Holscher
@ericholscher
I have @readthedocs & @writethedocs stickers. Also a Sphinx and RST cheat sheet. Come find me to get one. #djangocon
-
Read the Docs reposted
Eric Holscher
@ericholscher
Will be speaking in the Amphitheater at 2:50 this afternoon.
Learn more about how to think about writing docs & hosting them. #djangocon -
Read the Docs reposted
Aldryn is now Divio
@getaldryn
We're very pleased to be able to support @writethedocs and @readthedocs - pillars of the open-source software development community. Thanks!
-
Read the Docs reposted
Write the Docs
@writethedocs
This is part of the problem that Write the Docs is trying to address. Making writing & documentation a first class part of the tech world.
-
Read the Docs
@readthedocs
Sorry for the unplanned downtime everyone, our dashboard and project builds are back to normal after an outage triggered this morning.
-
Read the Docs reposted
Eric Holscher
@ericholscher
Reminder: I will be doing a 3 hour tutorial about Sphinx & Read the Docs at @djangocon: 2015.djangocon.us/schedule/presentation/5/ β Sign ups are still open.
-
Read the Docs
@readthedocs
We have deployed a new build page and build system updates that will catch errors better, and be much more useful. Hope you like it! :)
-
Read the Docs reposted
Write the Docs
@writethedocs
Reminder: Ticket sales for our Prague conf end on August 20 at midnight CET! ti.to/writethedocs/write-the-docs-eu-2015 #writethedocs
-
Read the Docs reposted
SitePoint PHP
@SitePointPHP
Using #sphinx for documenting #php projects on @readthedocs - a full guide by @bitfalls: www.sitepoint.com/using-sphinx-for-php-project-documentatβ¦
-
Read the Docs reposted
Tim Hopper
@tdhopper
Thanks to @rackspace for sponsoring @readthedocs. Itβs a resource I use every day.
-
Read the Docs reposted
Lovell Fuller
@lovell
Moving "sharp" docs from a README.md to @readthedocs revealed the type of help people need e.g. installation > usage.
-
Read the Docs reposted
DjangoCon US
@djangocon
Could you be doing a better job with your docs? Let @ericholscher show you the way in his tutorial! www.eventbrite.com/e/djangocon-us-2015-tickets-16265466448
-
Read the Docs
@readthedocs
We had an issue with some of our media files being served with the wrong content type, causing some docs to be unstyled. It is now resolved.
-
Read the Docs
@readthedocs
We have also just completed a total redeployment of our web servers, so please let us know if anything is acting abnormal.
-
Read the Docs
@readthedocs
We have deployed a number of performance improvements over the last few days. Hopefully the site is feeling a good bit faster now.
-
Read the Docs
@readthedocs
Database issues have been resolved. Sorry about the admin downtime β documentation serving should have remained unaffected.
-
Read the Docs
@readthedocs
We're currently experiencing problems with our database. Project admin pages are affected, but documentation should still be available.
-
Read the Docs
@readthedocs
We had some issues with 502's this morning because of a corrupt filesystem on one of our web servers. Should be resolved now.
-
Read the Docs
@readthedocs
Our Work Report for June 2015: blog.readthedocs.com/report-june-2015/ β Lots of amazing work has been done thanks to our community. There's more to come!
-
Read the Docs reposted
GovHack Australia
@GovHackAU
Whilst you cant work on your project until #govhack weekend, that doesn't mean you can't be preparing with new skills govhack-toolkit.readthedocs.io/event-info/preparation/
-
Read the Docs reposted
Jirka Vrany
@barneyalbert
@readthedocs is simply awesome when you preparing for long travel without connection. #thanks
-
Read the Docs reposted
Eric Holscher
@ericholscher
A reminder if you have thoughts about documentation, you should submit a talk to @writethedocs EU in Prague, Aug 31 β www.writethedocs.org/conf/eu/2015/cfp/
-
Read the Docs reposted
Django Birthday
@djangobirthday
We are excited to announce our next speaker and former Lawrencian, @ericholscher of @readthedocs fame: djangobirthday.com/speakers/
-
Read the Docs reposted
MkDocs
@MkDocsProject
As of today, @readthedocs is now running the latest MkDocs release, 0.13.2!
-
Read the Docs reposted
gandi.net
@gandibar
Hat tip to those who create great docs. This month, every new .xyz domain (only $2.50!) benefits @readthedocs: www.gandi.net/news/en/2015-05-12/4049-support_readthedocs⦠@xyz
-
Read the Docs reposted
Felipe Hoffa
@felipehoffa
A full cookbook googlegenomics.readthedocs.org/en/latest/ on how to analyze your genes with BigQuery and @googlecloud. We are doing it!
-
Read the Docs
@readthedocs
One of our build machines died in the Xen restarts last night, so builds might be slow today. Will get another one up soon.
-
Read the Docs reposted
gandi.net
@gandibar
We're proud to name @readthedocs as May's featured @xyz project; we'll donate $1 for each .XYZ created this month! www.gandi.net/news/en/2015-05-12/4049-support_readthedocsβ¦
-
Read the Docs reposted
Anthony Johnson (@aj@ohess.org)
@agjhnsn
The new @readthedocs office features a (very) open layout, an easy hike commute in, and we even have⦠instagram.com/p/2bkqnnvN60/
-
Read the Docs
@readthedocs
Super excited to be doing our part in helping Microsoft build amazing open source tools with @aspnet: docs.asp.net/en/latest/
-
Read the Docs
@readthedocs
With our fundraiser, Read the Docs is hiring 2 part-time contractors: blog.readthedocs.com/read-the-docs-is-hiring/ β Get paid to work on OSS for 3 months. Woo!
-
Read the Docs
@readthedocs
We're officially running Sphinx 1.3.1 as the default version. Please file any bugs that you find with the new version with us.
-
Read the Docs
@readthedocs
We have released v0.1.8 of our theme, including support for Sphinx 1.3. It will be deployed soon, more info here: github.com/snide/sphinx_rtd_theme
-
Read the Docs reposted
Aaron Schumacher
@planarrowspace
It's so easy to set up @readthedocs! Awesome.
-
Read the Docs
@readthedocs
Thanks everyone! Here is our fundraising wrap up. We'll have more information about our plans in the coming weeks: blog.readthedocs.com/fundraising-wrapup/
-
Read the Docs
@readthedocs
Large thanks to our biggest corporate backers: @ThePSF, @twilio, @getsentry, @dreamhost, @LincolnLoop & @oddestbirds.
-
Read the Docs
@readthedocs
We have reached our goal for our 3 month sustainability campaign! Thanks to all 155 supporters so far! readthedocs.org/sustainability/
-
Read the Docs
@readthedocs
Thanks to @thepsf for supporting Read the Docs with a $8,000 grant. We are so close to our goal β readthedocs.org/sustainability/
-
Read the Docs reposted
Lincoln Loop
@LincolnLoop
Join us in helping make Read the Docs more sustainable readthedocs.org/sustainability/ via @readthedocs
-
Post not available here, view on X
Read the Docs
@readthedocs
@regebro We're experiencing a back up publishing documentation builds, should be resolved shortly
-
Read the Docs
@readthedocs
With a little over a week left to hit our goal, we are currently 38% funded. Help make us more sustainable: readthedocs.org/sustainability/
-
Read the Docs reposted
Write the Docs
@writethedocs
Here are lots more details on our upcoming Portland conference: www.writethedocs.org/conf/na/2015/news/more-conference-deβ¦ β Get excited and get your ticket soon!
-
Read the Docs reposted
Sylvain Boily
@quintana_
#xivo contribute to Help make Read the Docs more sustainable readthedocs.org/sustainability/ @readthedocs @avencall Thank you for you great service!
-
Read the Docs reposted
A Curious Mind π
@drusellers
Just realized OmniSharp docs are on @readthedocs <3
-
Read the Docs reposted
Carl Meyer
@carljm
There's no better way to host docs than @readthedocs, but those servers don't pay for themselves. Donate with me! readthedocs.org/sustainability/
-
Read the Docs reposted
Project FiFo
@project_fifo
We take pride in our docs, and in supporting @readthedocs sustainability project - readthedocs.org/sustainability/ join us!
-
Read the Docs reposted
dave fatista
@dar9000
I'm a developer in a 3rd world country. I contributed to @readthedocs readthedocs.org/sustainability/
-
Read the Docs
@readthedocs
Our team just woke up at 5am to help fix database issues. We're not paid to do this, help us change this: readthedocs.org/sustainability/
-
Read the Docs reposted
Eric Holscher
@ericholscher
"I can't say I'm self taught. I've been taught by the people who wrote the documentation." #writethedocs
-
Read the Docs reposted
gandi.net
@gandibar
Today we (gratefully) provided (fantastic) @readthedocs with SSL certs and discounted domains. You can pitch in too: readthedocs.org/sustainability/contribute
-
Read the Docs reposted
Eric Holscher
@ericholscher
Ever contributed to @readthedocs? At #pycon? Come get a sticker, or contribute now: readthedocs.org/sustainability/
-
Read the Docs reposted
Daniel Roy Greenfeld, writer
@pydanny
So many open source projects use it for documentation. Help make Read the Docs sustainable readthedocs.org/sustainability/ via @readthedocs
-
Read the Docs reposted
Eric Holscher
@ericholscher
I wrote about @readthedocs and sustainability in OSS: ericholscher.com/blog/2015/apr/10/making-read-the-docs-suβ¦ β Will add more thoughts over the coming weeks, lots to say.
-
Read the Docs
@readthedocs
Help us make Read the Docs more sustainable and provide better support: readthedocs.org/sustainability/
-
Read the Docs reposted
David R. MacIver
@DRMacIver
Reminder by the way that if you don't write Python but do want a quickcheck, I have an "ideas you should steal" page: hypothesis.readthedocs.org/en/master/internals.html
-
Read the Docs reposted
Christopher Groskopf
@onyxfish
csvkit 0.9.1 has been released! Adds some missing docs and works around the infamous openpyxl issue: csvkit.readthedocs.org/en/0.9.1/
-
Read the Docs reposted
Eli Bressert
@elibressert
Truly awesome package for creating unit tests to sanitize your code in a sane and friendly way: hypothesis.readthedocs.org/en/latest/
-
Read the Docs reposted
Write the Docs
@writethedocs
The lineup for our upcoming conference has been decided! See what everyone will be talking about at Write the Docs: www.writethedocs.org/news/announcing-presentations/
-
Read the Docs
@readthedocs
Our service provider is doing restarts again this evening. We are doing our best to minimize downtime, but some builds might be delayed.
-
Read the Docs
@readthedocs
Our hosting provider is doing restarts for a vulnerability, we have fixed all effected services, but might have more short downtime today.
-
Read the Docs reposted
Write the Docs
@writethedocs
Do you have opinions on Markdown vs. reStructuredText vs. Asciidoc? You aren't alone: www.writethedocs.org/conf/na/2015/
-
Read the Docs reposted
Titus Brown
@ctitusbrown
I've set up a @readthedocs site for my nascent training program in Data Intensive Biology at @ucdavis: dib-training.readthedocs.org/en/pub/
-
Read the Docs
@readthedocs
Don't forget that Sphinx development has moved to GitHub here: github.com/sphinx-doc/sphinx
-
Read the Docs
@readthedocs
Remember, there is a Sphinx Live Preview online at: livesphinx.herokuapp.com -- Only supports single page, but great for previewing rendering.
-
Read the Docs reposted
Write the Docs
@writethedocs
Like documentation, coding, and library tech? Join us for the Write the Docs Pre-conference at code4lib on Monday: www.meetup.com/Write-The-Docs-PDX/events/219854275/
-
Read the Docs
@readthedocs
Remember, Sphinx is a great generic documentation tool. It isn't just for Python: ericholscher.com/blog/2014/feb/11/sphinx-isnt-just-for-pyβ¦
-
Read the Docs
@readthedocs
Need a place to start when writing docs? The Write the Docs Guide is a great place to point people: docs.writethedocs.org #writethedocs
-
Read the Docs
@readthedocs
These posts on Writing Great Documentation by @jacobian is a classic, and recommended for anyone who writes docs: jacobian.org/writing/great-documentation/
-
Read the Docs reposted
Write the Docs
@writethedocs
Announcing Call for Proposals and Ticket Sales: www.writethedocs.org/news/cfp-ticket-prices/ #writethedocs
-
Read the Docs reposted
Write the Docs
@writethedocs
Announcing Write the Docs NA 2015: www.writethedocs.org/news/announcing-2015/ β May 17-19 in Portland, Oregon. #writethedocs
-
Post not available here, view on X
Read the Docs
@readthedocs
@questmasternet You have to enable them in the project admin on RTD.
-
Post not available here, view on X
Read the Docs
@readthedocs
@questmasternet Yes, they should map to your github tags & versions: docs.readthedocs.org/en/latest/versions.html has a bit more.
-
Read the Docs
@readthedocs
In case you missed this, we took a look back at our stats for 2014: blog.readthedocs.com/read-the-docs-2014-stats/
-
Read the Docs
@readthedocs
We took a look back on last year, here's some of our stats for 2014: blog.readthedocs.com/read-the-docs-2014-stats/
-
Read the Docs
@readthedocs
"An hour spent documenting at 2 p.m. may prevent an urgent call at 2 a.m." #writethedocs
-
Read the Docs reposted
Write the Docs
@writethedocs
A reminder that we have awesome meetups in lots of cities across the US. Come join us in the new year: conf.writethedocs.org/meetups.html #writethedocs
-
Read the Docs
@readthedocs
Our provider is mitigating a DDOS attack affecting their DNS. Users on some ISPs may not be able to connect. We're working on a solution!
-
Read the Docs
@readthedocs
Apologies to anyone trying to read docs right now, our upstream host is experiencing problems. We'll be back up shortly
Read the Docs
@readthedocs
And we're back. If you're still having trouble, there could be some lingering DNS lookup issues that should resolve shortly.
-
Read the Docs reposted
Ned Batchelder
@nedbat
If you write (or know of examples of) ReStructured Text files in Arabic, I'd like to chat, especially about #readthedocs.
-
Read the Docs
@readthedocs
Documentation builds were unjammed, projects should be back to building as normal.
-
Read the Docs
@readthedocs
Builds have been backed up this morning, we're working to get builds moving quicker now.
-
Read the Docs
@readthedocs
We just passed 100 Million page views for the year. Thanks to everyone out there reading and writing the docs :)
-
Read the Docs
@readthedocs
Glad to see @hylang getting some love on Hacker News. It's a neat lisp embedded in Python: docs.hylang.org/en/latest/
-
Read the Docs reposted
Hacker News Bot
@newsycombinator
-
Read the Docs
@readthedocs
Builders are fixed and back online. Sorry for any delay or invalid build failure reports.
-
Read the Docs
@readthedocs
We're having an issue with our builders currently. We are investigating and it should be fixed soon. We have paused builds for now.
-
Read the Docs reposted
Django
@djangoproject
Our documentation can also be found on @readthedocs: django.readthedocs.org
-
Read the Docs reposted
O'Reilly Infrastructure & Ops
@OReillyInfraOps
In case you didn't catch Daniel's #dockerhackday fig @readthedocs repo: github.com/dnephin/readthedocs.org
-
Read the Docs reposted
Richard
@rnewman
Now this is how you write docs. Great job, @indygreg et al. mozilla-version-control-tools.readthedocs.org/en/latest/
-
Read the Docs
@readthedocs
We have deployed changes to our top-level redirect code so that it no longer depends on a database. Todays downtime should not happen again.
-
Read the Docs
@readthedocs
All pages should be serving normally again. Documentation building should also be back to normal.
-
Read the Docs
@readthedocs
Our database server is acting up. All documentation pages should be serving properly, other than front pages.
-
Read the Docs
@readthedocs
Notice a new `stable` branch for your docs? We're automatically pointing that at your latest tagged release: docs.readthedocs.org/en/latest/versions.html
-
Read the Docs
@readthedocs
We have fixed our build failure emails. Let us know if there is anything with them you'd like us to change.
-
Read the Docs reposted
Simple Injector
@simpleinjector
From this moment on readthedocs.org is our new home for our documentation: simpleinjector.readthedocs.org #simpleinjector
-
Read the Docs reposted
Write the Docs
@writethedocs
A reminder that we have a basic beginners guide to writing documentation: docs.writethedocs.org/writing/beginners-guide-to-docs/ #writethedocs
-
Read the Docs
@readthedocs
All systems should be back to normal. We will continue to check all our backend systems.
-
Read the Docs
@readthedocs
Having trouble failing over database because of server restarts by our hosts. Will keep trying, doc serving remains unaffected.
-
Read the Docs
@readthedocs
Serving docs should continue to function though.
-
Read the Docs
@readthedocs
Our database server failed to reboot cleanly. Failing over to a new machine now.
-
Read the Docs reposted
Pierre Mavro
@deimosfr
#readthedocs: a hosting documentation solution with @GitHub @readthedocs @mysecureshell blog.deimos.fr?p=4953
-
Read the Docs
@readthedocs
Reminder we will be sprinting on Read the Docs at the #djangocon sprints! Come find us tomorrow and help make community docs better.
-
Read the Docs
@readthedocs
We are participating in the @djangocon sprints next week, Sept 5/6. Come help us improve the documentation experience in the community.
-
Read the Docs
@readthedocs
In case you missed it Friday, we now support user-defined redirects for docs: blog.readthedocs.com/user-defined-redirects/ β Great for fixing 404s.
-
Read the Docs
@readthedocs
New feature: User-defined Redirects. Fix 404's from an old doc move, or change your docs around a bit: blog.readthedocs.com/user-defined-redirects/
-
Read the Docs reposted
Paul Lamere
@plamere
Spotipy is officially at version 2.0 with all new and spiffy docs and examples - spotipy.readthedocs.org
-
Read the Docs reposted
Paul Lamere
@plamere
This spotipy release was my 1st foray into readthedocs.org - it's a super system for managing docs. Thanks for the tip @nedjl
-
Read the Docs
@readthedocs
New feature: Badges! We now have badges on project pages, ready for your docs and README's β blog.readthedocs.com/badge-support/
-
Read the Docs reposted
Eric Holscher
@ericholscher
Excited to be working on @readthedocs full-time for the next 3 months: ericholscher.com/blog/2014/aug/8/read-the-docs-goes-full-β¦ β Thanks to @piepdx
-
Read the Docs reposted
Eric Holscher
@ericholscher
Fun fact: Read the Docs & Django Packages were both built in the basement of the Lawrence Journal-World, the same place Django was created.
-
Read the Docs reposted
Jeff Madsen
@codebyjeff
Lovely stuff, Phinx (@_rjm_ ), lovely stuff docs.phinx.org/en/latest/index.html
-
Read the Docs reposted
Mitch Garnaat
@garnaat
Congratulations to the AWS Python team for the release of Boto 2.32.0 with Python 3 support! boto.readthedocs.org/en/latest/releasenotes/v2.32.0.html
-
Read the Docs reposted
SaΓΊl Ibarra CorretgΓ©
@saghul
Work in progress Official API documentation for #libuv is a go! libuv.readthedocs.org You can help too! github.com/libuv/api-docs
-
Read the Docs
@readthedocs
Want to support us but aren't on Gittip, you can still give money here: app.moonclerk.com/pay/27n2xc745yw
-
Read the Docs reposted
Cory Benfield
@Lukasaoz
New favourite @readthedocs feature: the default theme's CSS has accurate printer directives, so printing the page looks awesome. Try it!
-
Read the Docs reposted
Eric Holscher
@ericholscher
One of the most comprehensive and well thought out posts on software documentation I've seen: brikis98.blogspot.de/2014/05/you-are-what-you-document.html β Well done @brikis98
-
Read the Docs
@readthedocs
We'll be upgrading our servers tonight. Please let us know if you see any issues. There should be no downtime.
-
Read the Docs reposted
Cory Benfield
@Lukasaoz
I'd just like to thank @enemykite for his work on the @readthedocs theme. My documentation is gorgeous thanks to him. =) #positivepython
-
Read the Docs
@readthedocs
Having issues with our load balancers connectivity. Failing over, DNS should update in <5 mins.
-
Post not available here, view on X
Read the Docs
@readthedocs
@_dsawardekar @markjaquith @nacin Indeed. Sounds like a good question to ask folks who are coming to @writethedocs next week, also :)
-
Read the Docs
@readthedocs
Looking for a Sphinx theme? Here are a few that are great: docs.writethedocs.org/tools/sphinx-themes/
-
Read the Docs
@readthedocs
Looks like our LB has been flapping a bit, looking into it.
-
Read the Docs reposted
Tom
@ThomasLeenders
OpenWorm is pretty darn cool (smart people trying to make a digital worm). docs.openworm.org/en/latest/intro.html
-
Read the Docs reposted
ultraconserved
@ultraconserved
phyluce, the code for UCE analyses, has been updated, improved, has an installer, and now has proper documentation:
phyluce.readthedocs.org/en/latest/ -
Read the Docs
@readthedocs
We just passed 10,000 projects that have been created on the site. Thanks to everyone out there creating documentation.
-
Read the Docs reposted
Ben Welsh
@palewire
#confirmed: Our open-source django-bakery static site maker django-bakery.rtfd.org helped produce a Pulitzer finalist www.pulitzer.org/citation/2014-Public-Service
-
Read the Docs reposted
Eric Holscher
@ericholscher
Sprinting on @readthedocs at #pycon in room 519B. Come join us, or jump in #readthedocs on Freenode if you want to help remotely.
-
Read the Docs
@readthedocs
There was an issue that caused some top-level URLs to have a redirect loop. Should be fixed now. Sorry for the issues.
-
Read the Docs reposted
Los Angeles Times Data and Graphics
@datagraphics
New documentation for our open-source static site generator, django-bakery, at @readthedocs django-bakery.rtfd.org
-
Read the Docs reposted
Eric Holscher
@ericholscher
Seeing documentation for Java code in Japanese on @readthedocs brings me great joy: doma.readthedocs.org/ja/latest/
-
Read the Docs
@readthedocs
We have pushed out the first stage of a refactor of our builder code. Please let us know if you see any odd issues.
-
Read the Docs reposted
Thomas Maroschik
@tmaroschik
@xperseguers I like this one very much docs.masstransit-project.com/en/latest/index.html
-
Read the Docs reposted
Markus Zapke-GrΓΌndemann
@keimlink
Only two weeks until I speak at Write the Docs Europe about using Sphinx for multi-language documentation - so exited conf.writethedocs.org/eu/2014/
-
Read the Docs reposted
Ben Welsh
@palewire
The docs for our grabbag of Python math now also ported to @readthedocs latimes-calculate.rtfd.org Get excited.
-
Read the Docs
@readthedocs
Sorry, our Load Balancer is having network issues. Investigating now.
-
Read the Docs reposted
Eric Holscher
@ericholscher
If you had to highlight 2-3 features of Sphinx, what would they be? And how would you highlight them? eric@ericholscher.com for more chars.
-
Read the Docs reposted
noirello
@noirello
New release in the repository and uploaded documentation at pyldap.readthedocs.org/en/latest/ #pyldap
-
Read the Docs reposted
Eric Holscher
@ericholscher
This has got to be one of the coolest packages hosted on @readthedocs: sunpy.readthedocs.org/en/latest/guide/tour.html
-
Read the Docs
@readthedocs
If you care about documentation and live in Europe, you should attend Write the Docs EU in Budapest March 31-Apr 1: conf.writethedocs.org/eu/2014/
-
Read the Docs
@readthedocs
We have our first translation live! Our getting started page in Italian: docs.readthedocs.org/it/latest/getting_started.html
-
Read the Docs
@readthedocs
We are looking for people who are interested in translating our documentation: www.transifex.com/projects/p/readthedocs-docs/ β At least the getting started doc.
-
Read the Docs reposted
Erik Rose
@ErikRose
@jeanqasaur Sphinx. Sphinx sphinx sphinx. readthedocs is all sphinx. My packages are all sphinx. Love it. Even for non-Python projects.
-
Read the Docs reposted
Alyssa Coghlan
@ncoghlan_dev
Thanks to @dstufft, the Python Packaging User Guide now has a python.org subdomain: packaging.python.org (cc @qwcode)
-
Read the Docs
@readthedocs
Looking for a new theme for your Sphinx project? Here are three that are great: docs.writethedocs.org/tools/sphinx-themes/
-
Read the Docs reposted
Write the Docs
@writethedocs
Announcing Conference Talks and a Party for Write the Docs EU: docs.writethedocs.org/2014/blog/announcing-conference-talβ¦
-
Read the Docs reposted
Eric Holscher
@ericholscher
Thanks to @birkenfeld for creating Sphinx. Sphinx was visionary at the time it was created, and it's still an amazing tool. #positivepython
-
Read the Docs reposted
Eric Holscher
@ericholscher
Sphinx isn't just for Python: ericholscher.com/blog/2014/feb/11/sphinx-isnt-just-for-pyβ¦
-
Read the Docs
@readthedocs
We have rolled out an update to our Git backend, so if you have issues updating your docs that use Git, please let us know.
-
Read the Docs reposted
Nguyen Duc Tam
@tamnd87
Welcome to Hyβs documentation! β hy 0.9.12 documentation - bitly.ift.tt/K6zLUU
-
Read the Docs reposted
Write the Docs
@writethedocs
A reminder that we have docs about writing docs available: docs.writethedocs.org/en/latest/ - It is a growing resource, so feel free to contribute!
-
Read the Docs reposted
PHP Web Developer
@phpizer
Bookie - bookmark your web β Bookie 0.5.0 documentation docs.bmark.us/en/latest/
-
Read the Docs
@readthedocs
125 people now help support Read the Docs on @gittip: www.gittip.com/readthedocs/ β Thanks for your support in making docs better for everyone!
-
Read the Docs reposted
Peter Niederwieser
@pniederw
#julia seems to have everything I ever wanted in a prog lang, just simpler & better. Hooked. docs.julialang.org/en/latest/manual/
-
Read the Docs reposted
Ben Welsh
@palewire
Wave of improvements to #nicar14's draft "First News App" course thanks to your early testing. Keep it coming! first-news-app.readthedocs.org/en/latest/
-
Read the Docs reposted
Clem Blanco
@clemblanco
Sublime Text Unofficial Documentation docs.sublimetext.info/en/latest/index.html
-
Read the Docs
@readthedocs
We have been working on a global search interface for our data. Check out a demo here: searchthedocs.herokuapp.com
-
Read the Docs reposted
Jay Parlar
@parlar
The quality of the docs at cryptography.io/en/latest/ is a thing of beauty. Bravo @alex_gaynor et. al.
-
Read the Docs reposted
bakdata
@bakdata
#pytoolz (toolz.readthedocs.org) deserves more buzz. Composed curried functions are also great for wrangling #pandas DataFrames. #pydata fk
-
Read the Docs reposted
BinaryTides - Linux | Coding | Technology
@binarytides
Configuring Nginx on your server ? Check out this tutorial to learn about best practices.
docs.ngx.cc/en/latest/topics/tutorials/config_pitfalls.html
#linux #nginx -
Read the Docs reposted
John Matherly
@achillean
The documentation for the Shodan Python library has moved to shodan.readthedocs.org/en/latest/index.html
-
Read the Docs
@readthedocs
We had some issues with long queues on the build server earlier. They should be resolved.
-
Read the Docs reposted
glyph
@glyph
Also, in case it wasn't clear from the previous tweet, twisted.readthedocs.org is a thing now, too.
-
Read the Docs
@readthedocs
We have turned on localization for Chinese and Vietnamese language on Read the Docs. Help us translate here: www.transifex.com/projects/p/readthedocs/
-
Read the Docs
@readthedocs
We documented how to support multiple languages of your project: docs.readthedocs.org/en/latest/localization.html
Hope to see more translated docs in the future :) -
Read the Docs
@readthedocs
Sphinx 1.2 is now the default for all builds. Read the release notes here: sphinx-doc.org/changes.html
-
Read the Docs
@readthedocs
We now support single version documentation. This means you can host docs at the root of your domain: docs.readthedocs.org/en/latest/single_version.html
-
Read the Docs
@readthedocs
The site should now be localized in Spanish, French, and Norwegian. Want to help translate? Help us on @transifex: www.transifex.com/projects/p/readthedocs/
-
Read the Docs
@readthedocs
In case you missed it, we posted stats for 2013: ericholscher.com/blog/2013/dec/23/read-the-docs-2013-stats/
-
Read the Docs
@readthedocs
We just released basic support for canonical URLs: docs.readthedocs.org/en/latest/canonical.html β Please test them out and let us know if they work well for you.
-
Read the Docs reposted
Peter Bengtsson
@peterbe
It's not new but I just have to iterate it; I *really* like the new ReadTheDocs design. Great use of fonts and colors.
-
Read the Docs
@readthedocs
Great talk by @doughellmann on creating Sphinx Extensions: www.youtube.com/watch?v=8vwtgMkqE9o
-
Read the Docs reposted
Brian Boyer
@brianboyer
Rereading @brianabelson's awesome "Pageviews Above Replacement" brianabelson.com/open-news/2013/11/14/Pageviews-above-rep⦠& geeked to play w/ Particle. particle.readthedocs.org/en/latest/
-
Read the Docs reposted
Eric Holscher
@ericholscher
Read the Docs 2013 Stats: ericholscher.com/blog/2013/dec/23/read-the-docs-2013-stats/
-
Read the Docs reposted
Felix GeisendΓΆrfer
@felixge
.@readthedocs I have to say Iβm incredibly happy so far. Amazing service. Thank you for providing it. *signs up for gittip now*
-
Read the Docs reposted
Write the Docs
@writethedocs
Announcing Write the Docs 2014: docs.writethedocs.org/en/latest/2014/blog/announcing-writβ¦ β Now with a North American and European version!
-
Read the Docs
@readthedocs
Had an issue with the build server backing up. It should be fixed now, but builds may take a few minutes to clear out and starting going.
-
Post not available here, view on X
-
Read the Docs
@readthedocs
Over 100 people donate to @readthedocs on @gittip: www.gittip.com/readthedocs/ -- Starting giving today, even a dollar a month helps!
-
Read the Docs reposted
Ada Wright
@pypikat
New Read the Docs theme is making it feel like all of Python had a facelift.
-
Read the Docs
@readthedocs
Reminder that there is a Sphinx IRC channel on Freenode at #sphinx-doc & Read the Docs channel at #readthedocs
-
Read the Docs
@readthedocs
Doing some server maintenance this weekend. Lots of work goes to keeping the site up and fast, help support us: www.gittip.com/readthedocs/
-
Read the Docs
@readthedocs
If you need the Django docs while they are down, we always host a mirror: django.readthedocs.org/en/latest/
-
Read the Docs reposted
Brandon Konkle
@bkonkle
I can't get over how good the new ReadTheDocs theme is. So modern & fresh. The design has nothing to do with content but it matters so much!
-
Read the Docs
@readthedocs
A nice screencast about getting started with Sphinx & Read the Docs: www.neckbeardrepublic.com/screencasts/sphinx-read-the-docs
-
Read the Docs reposted
Hynek Schlawack
@hynek
Itβs great how much of an overall impact it made that ReadTheDocs changed their theme. :)
-
Read the Docs
@readthedocs
Enjoying the latest site upgrades? They have been possible because of our funding on @gittip: www.gittip.com/readthedocs/
-
Read the Docs reposted
Eric Holscher
@ericholscher
Announcing a new theme for Read the Docs: ericholscher.com/blog/2013/nov/4/new-theme-read-the-docs/
-
Read the Docs reposted
Eric Holscher
@ericholscher
Excited about the @readthedocs Hackathon tomorrow. Jump in #readthedocs on IRC if you want to join remotely.
-
Read the Docs
@readthedocs
We have pushed out a new badge, let us know if you have any issues with it. It will update as you update your docs.
-
Read the Docs
@readthedocs
To try out the new theme, add the line "RTD_NEW_THEME = True" to your conf.py file and rebuild your docs. Let us know if anything breaks :)
-
Read the Docs
@readthedocs
Sneak peek of the new design: i.imgur.com/UDjn7JT.png
-
Read the Docs
@readthedocs
Just to warn everyone, we are going to be upgrading the default theme this week, into something that is much, much better. Stay tuned! :)
-
Read the Docs
@readthedocs
Reminder we are doing a hack day in PDX next Saturday: www.meetup.com/pdxpython/events/142472922/ -- Feel free to join in IRC at #readthedocs on Freenode.
-
Read the Docs reposted
Eric Holscher
@ericholscher
Announcing Grok the Docs: ericholscher.com/blog/2013/oct/7/announcing-grok-the-docs/ - If you host or use docs on @readthedocs, this will be of interest to you.
-
Read the Docs reposted
Eric Holscher
@ericholscher
I hacked up a basic Sphinx Live Preview. Blog: ericholscher.com/blog/2013/oct/1/sphinx-live-preview/ DIrect: livesphinx.herokuapp.com
-
Read the Docs
@readthedocs
Reminder that we are doing a sprint day on October 26. Physical meet up in Portland: calagator.org/events/1250464753 - #readthedocs on IRC everywhere
-
Read the Docs reposted
Eric Holscher
@ericholscher
Help me improve documentation: ericholscher.com/blog/2013/sep/25/help-me-improve-documenβ¦
-
Read the Docs reposted
DOUG BLACK
@dougblackio
just look at all of this gorgeous documentation
ruby: twilio-ruby.readthedocs.org/en/latest/
php: twilio-php.readthedocs.org/en/latest/
python: twilio-python.readthedocs.org/en/latest/ -
Read the Docs reposted
Django Dash
@djangodash
Registration opens in 24 hours!
-
Read the Docs reposted
TiddlyWeb
@tiddlyweb
Started work on finally getting TiddlyWeb on @readthedocs. Still a lot to do but at least it is started: tiddlyweb.readthedocs.org
-
Read the Docs reposted
ee
@EWDurbin
bummer, seeing that PyPI hosts 1.9G of package docs, and 56G of packages. i hope thatβs because everyone moved their docs to @readthedocs
-
Read the Docs
@readthedocs
We have upgraded our infrastructure and bumped project some versions, let use know if you have any issues with failing builds.
-
Read the Docs reposted
Eric Holscher
@ericholscher
Example: dl.dropboxusercontent.com/u/372293/gifs/rst-example.gif - β@readthedocs: This reStructuredText extension for Sublime Text is pretty great: github.com/dbousamra/sublime-rst-completionβ
-
Read the Docs
@readthedocs
This reStructuredText extension for Sublime Text is pretty great: github.com/dbousamra/sublime-rst-completion
-
Read the Docs reposted
Amjith
@amjithr
Woot! @readthedocs now runs @newrelic on their site (readthedocs.org). Proud to support the worthy cause of writing and reading docs.
-
Read the Docs
@readthedocs
We are having a hack day in PDX on October 26th: calagator.org/events/1250464753
-
Read the Docs reposted
Petri Lehtinen
@akhern
Jansson's documentation is now hosted on @readthedocs \o/ Benefits: Automatic builds, mobile-aware theme. jansson.readthedocs.org
-
Read the Docs reposted
Petri Lehtinen
@akhern
I blogged about Jansson and @readthedocs: www.digip.org/blog/2013/08/jansson-s-documentation-moved-β¦
-
Read the Docs reposted
AdriΓ Mercader
@amercader
Pro tip: All @CKANproject docs can be downloaded in single PDFs, eg media.readthedocs.org/pdf/ckan/latest/ckan.pdf (as all docs hosted on @readthedocs)
-
Read the Docs reposted
Eric Holscher
@ericholscher
@xoebus @hiremaga FWIW, nothing Python specific about it. The tooling is written in Python, but anyone can use Sphinx and @readthedocs :)
-
Read the Docs
@readthedocs
There was an issue with importing projects over night. It should now be resolved. Sorry about that!
-
Read the Docs
@readthedocs
We have upgraded to the latest Django 1.4.6 security release. You should too: www.djangoproject.com/weblog/2013/aug/13/security-releaseβ¦
-
Read the Docs reposted
mattstadon.co.uk
@mwhooker
@dysinger went back and forth on it but decided I wanted to show off @adainitiative @PyLadies_pdx and @readthedocs
-
Read the Docs
@readthedocs
We are featuring pip & wheel on the front page to celebrate the latest release of pip! www.pip-installer.org/en/1.4/news.html
-
Read the Docs
@readthedocs
We had a patch go awry the other day, this left some 'triggered' builds. We've fixed things up and cleared out those builds.
-
Read the Docs reposted
Write the Docs
@writethedocs
Reminder that we have a mailing list on Google Groups: groups.google.com/forum/ -- Join and talk about documentation stuff :)
-
Read the Docs
@readthedocs
Just renewed all our domain names with money from @gittip. A reminder that we are funded by people like you: www.gittip.com/readthedocs/
-
Read the Docs reposted
Write the Docs
@writethedocs
Another reminder that all of the talks from the conference are available on Youtube: www.youtube.com/playlist?list=PLmV2D6sIiX3UpQFzAIWh-_gsUTβ¦
-
Read the Docs reposted
Antmicro
@antmicro
#android #zynq port docs now on @readthedocs - android-for-enclustra-mars-zx3-zynq-module.readthedocs.or⦠- suggestions welcome! Also, RTFD now has 'edit on github' - great!
-
Read the Docs reposted
Eric Holscher
@ericholscher
Pretty impressed that the @readthedocs gittip has stayed funded: www.gittip.com/readthedocs/ Thought it would drop off over time, but increased.
-
Read the Docs
@readthedocs
We experienced some issues last night (runaway process) and the queue has built up. If you are manually building, please only hit it once.
-
Post not available here, view on X
Read the Docs
@readthedocs
@joefriedl Also the vagrant box was from a contributor. I don't think it was ever 100% completed.
-
Post not available here, view on X
Read the Docs
@readthedocs
@joefriedl Yeah, unfortunately production setup is not easy. Come join in in #readthedocs on irc.freenode.net if you have questions.
-
Read the Docs reposted
K π¦ Love
@kennethlove
Use @duckduckgo and @readthedocs? Search with !rtd to find documentation
-
Read the Docs reposted
@wraithan@mastodon.art
@Wraithan
New blog post about tech: Plethora of Projects tech.wraithan.net/plethora-of-projects.html
-
Read the Docs
@readthedocs
Check out some live notes from this weeks @writethedocs! write-the-docs-2013-notes.readthedocs.org/en/latest/
-
Read the Docs reposted
Andrew Spittle
@andrewspittle
Notes from Write the Docs, Kenneth Reitz β Documentation is King: andrewspittle.net/2013/04/08/documentation-is-king/
-
Read the Docs
@readthedocs
We have updated our Postgres install. You should too! www.postgresql.org/about/news/1456/
-
Read the Docs reposted
Eric Holscher
@ericholscher
I will be presenting a poster about @readthedocs (and @writethedocs) at Pycon this weekend! Stop on by! us.pycon.org/2013/schedule/presentation/162/
-
Read the Docs reposted
Write the Docs
@writethedocs
Announcing our conference talks! docs.writethedocs.org/en/2013/conference/talks.html - Really excited about the scope and quality of the presentations.
-
Read the Docs
@readthedocs
What size should your typography be? webdesign.maratz.com/lab/responsivetypography/realtime/
-
Read the Docs
@readthedocs
An interesting article on what should be included in documentation: hackingdistributed.com/2013/02/11/principled-documentation/
-
Read the Docs
@readthedocs
Neat use of RTD as a Blog for your project, along with documentation: docs.topazruby.com/en/latest/blog/
-
Read the Docs reposted
Write the Docs
@writethedocs
Announcing Initial Speakers, Sponsors, and Ticket Prices! docs.writethedocs.org/en/2013/conference/initial-speakersβ¦
-
Read the Docs reposted
Write the Docs
@writethedocs
Write the Docs, Apr 8-9, Portland, OR, A conference for tech writers, documentarians, and all those who write the docs. conf.writethedocs.org
-
Read the Docs
@readthedocs
We had some issues with our build server last night, things should be back to normal now. Sorry about that.
-
Read the Docs
@readthedocs
Pushed out a bunch of new style updates, including a new Version selector, and new profile pages. Let us know if you see any issues.
-
Read the Docs
@readthedocs
Just pushed out some changes to the project maintainer section of the site. Should be nicer for project admins.
-
Read the Docs
@readthedocs
We have started a section for Designer Documentation on @readthedocs itself: docs.readthedocs.org/en/latest/ - Should make design contributions easier!
-
Read the Docs
@readthedocs
New feature: Linking to Github View/Edit pages. docs.readthedocs.org/en/latest/features.html - Goes great with @github's recent Create File functionality.
-
Read the Docs
@readthedocs
New @github feature to allow adding files in the web UI: github.com/blog/1327-creating-files-on-github - Should be good for basic documentation editing.
-
Read the Docs
@readthedocs
A couple @pycon talks on documentation this year: us.pycon.org/2013/schedule/presentation/113/ & us.pycon.org/2013/schedule/presentation/89/
-
Read the Docs
@readthedocs
A blog post about how Documentation makes your project's API better: kennethreitz.org/open-source-and-constraints.html by @kennethreitz
-
Read the Docs
@readthedocs
Good article on how to use Intersphinx with Django and @readthedocs: reinout.vanrees.org/weblog/2012/12/01/django-intersphinx.β¦
-
Read the Docs
@readthedocs
Anyone have good examples of educational stuff up on @readthedocs? Looking to feature neat uses of the site for learning/education.
-
Read the Docs
@readthedocs
Looking into build problems this morning. This is likely related to the data center migration that happened over the weekend.
-
Read the Docs
@readthedocs
Data Center Migration Complete -- Please let me know if you see any weirdness.
-
Read the Docs
@readthedocs
We will be doing a data center migration tonight at around 10PM Pacific - 5AM UTC. Shouldn't be any service interruption.
-
Read the Docs
@readthedocs
Having intermittent issues connecting from the build server to 1 web server. It should resolve itself, but some builds may get out of sync.
-
Read the Docs
@readthedocs
Just deployed the i18n branch of the site. Let us know if you see any weirdness or brokenness, as this was a good deal of code churn.
-
Read the Docs
@readthedocs
Reminder: Come hang out in #readthedocs on Freenode if you want to get involved in the project!
-
Read the Docs
@readthedocs
All requests to the main site should be redirecting to https now. Will turn on HSTS soon. Subdomains still http, for now.
-
Read the Docs
@readthedocs
Help fund @readthedocs! Blog post: ericholscher.com/blog/2012/sep/20/help-fund-read-docs/ Gittip for readthedocs: gittip.com/readthedocs
-
Read the Docs
@readthedocs
Had our build server fail. Spun up a new one. Let us know if your builds are broken for any reason.
-
Read the Docs
@readthedocs
Our main site had a 30min TTL, so DNS should be working again now or very soon. Sorry about the outage.
-
Read the Docs
@readthedocs
We have failed over our Load Balancer and updated DNS. Things should be coming back up now.
-
Read the Docs
@readthedocs
Our hosting provider is currently having network issues. We're looking into it and should be back up once they are resolved.
-
Read the Docs
@readthedocs
Reminder: we have SSL support. readthedocs.org -- You should be using this if you're ever logged in. We'll be moving full-SSL soon.
-
Read the Docs
@readthedocs
Everyone should sign up for the @djangodash and build something awesome! That's how @readthedocs got started.
-
Read the Docs
@readthedocs
We are doing some DNS surgery to prepare for launching SSL support. Let us know if you have any issues with the site.
-
Read the Docs
@readthedocs
Our database server is currently down. Filed a ticket with our hosting provider, and hoping it comes back. Docs should still be serving fine
-
Read the Docs
@readthedocs
Happy to announce our latest sponsor, @lab305. Thanks for supporting the site!
-
Read the Docs
@readthedocs
Featuring people who are live-noting #pycon on the front page of the site. readthedocs.org
-
Read the Docs
@readthedocs
Site should be back now. @rackspace said there was an outage in a cluster of servers that the site is running on.
-
Read the Docs
@readthedocs
More than half of our servers at @rackspace just disappeared. The site is currently down, talking to support there.
-
Read the Docs
@readthedocs
We just got our stickers for @pycon! i.imgur.com/SAIv9.jpg We'll have them at the poster session on Sunday, and around the conference.
-
Read the Docs
@readthedocs
We have deployed a refactor to the backend build system today. Let us know if you see weirdness with your builds.
-
Read the Docs
@readthedocs
We now have integration with crate.io on both sides. Ours: dl.dropbox.com/u/372293/Screenshots/o0fc.png - Theirs: dl.dropbox.com/u/372293/Screenshots/86um.png
-
Read the Docs
@readthedocs
Pushed out some new code that should allow us to remove whitelisting in the near future. Let us know if you see any oddness in builds.
-
Read the Docs
@readthedocs
Pushed out an update so that version info in the version selector should be up to date, and link to the same page on other versions.
-
Read the Docs
@readthedocs
We have officially passed the 1 million page views in the past month. Thanks to everyone who has helped make this possible!
-
Read the Docs
@readthedocs
We just spun up the new build server. This means that everyone will start over with a fresh environment. Let us know if things break.
-
Read the Docs
@readthedocs
Sorry about the disk space issues. We have a new server with more disk, we'll be adding it in as the builder today.
-
Post not available here, view on X
Read the Docs
@readthedocs
@therp_stefan Whitelist'd.
-
Read the Docs
@readthedocs
We're excited to be officially hosting the Pylons Project documentation! docs.pylonsproject.org/en/latest/index.html
-
Read the Docs
@readthedocs
There was a problem with mathjax and extensions that were using custom javascript. This should be fixed now.
-
Read the Docs
@readthedocs
We are moving to a Rackspace Cloud Load Balancer to hopefully remove Varnish as a SPOF. Let us know if you see any problems.
-
Read the Docs
@readthedocs
Sorry about that folks, our Load Balancer was having trouble this morning for about an hour. Will look into it.
-
Read the Docs
@readthedocs
Sphinx 1.1 has been released: sphinx.pocoo.org/changes.html
-
Read the Docs
@readthedocs
Featuring @pydanny and @joshbohde's #pycodeconf event notes on the front page today. Thanks for the creative use of the service!
-
Read the Docs
@readthedocs
Just added improvements to the site that should make CNAME'd domains load out of nginx. This should make them more reliable and faster.
-
Read the Docs
@readthedocs
Sorry folks, we had a misconfigured nginx config that might have caused your CNAME's front page to show weird chinese text. This is fixed.
-
Read the Docs
@readthedocs
Added some more things to speed up the site. Let us know if it still seems sluggish.
-
Read the Docs
@readthedocs
We've upgraded to 1.3.1, and you should too! www.djangoproject.com/weblog/2011/sep/09/security-releaseβ¦



















































































































