sphinx_rtd_theme
sphinx_rtd_theme copied to clipboard
readthedocs
Remove all instances of READTHEDOCS
We should make this theme like any other Sphinx theme when running on RTD. This means removing all the {% if READTHEDOCS %} blocks. There are only a couple left, but we should remove them all.
After we do this and have the theme fully abstracted, I think we should release it as a 1.0. I feel silly having it under 1.0, and want to move to real semvar on our projects going forward.
I'm fine sticking <1.0 until semver dictates a major version release. We definitely should have started at 1.0 for semver proper, but I don't think that this is a requirement to doing semver successfully. The most important part is that we are communicating backwards compat through versioning, which we are currently. Bumping to 1.0 would be sort of antithetical to these efforts actually.
1.0 generally means "we'll follow semvar" though -- "Version 1.0.0 defines the public API". So if we're <1.0, it's saying that we can still change whatever we want.
Agreed we should have started with 1.0, but we are still following semver. We don't get to change whatever we want without the version reflecting that. I think <1.0 is more truthful for now, and consistency is more important for package maintenance than correctness is in this case.
@agjohnson was there a reason to remove the 1.0 milestone? I think this would be a nice inclusion in the 1.0 release.
Mostly because we keep piling things into a 1.0 release and pushing out actually releasing 1.0. This doesn't feel immediately required.
Also, we're already dropping 1.6 and have some other large changes in our upcoming release. There is a lot of wisdom in cutting more frequent releases, and not making monolithic releases with a lot of important changes combined. This has always felt like the primary thing slowing this project down. 1.1 or great seems like a safe place for this new feature, this doesn't seem important as a 1.0 release feature.
