Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[INFRA] Enable version panel for quickly finding previous versions #232

Merged
merged 1 commit into from
May 17, 2019

Conversation

effigies
Copy link
Collaborator

@effigies effigies commented May 16, 2019

Just a note that I'm playing with trying to get RTD to play nicely.

In our builds, it acts as if there's no configuration file (example):

Configure your documentation builds! Adding a .readthedocs.yml file to your project is the recommended way to configure your documentation builds. You can declare dependencies, set up submodules, and many other great features.

First thing I'm trying is to fix our configuration, and will host the results at https://bids-specification.readthedocs.io/en/rtdtest/ when I can get it to build.

Replaces #231.
closes #228

@effigies effigies force-pushed the rtdtest branch 2 times, most recently from ba815c5 to 450bf72 Compare May 16, 2019 13:55
@effigies
Copy link
Collaborator Author

Some notes so I can close a ton of tabs:

@effigies
Copy link
Collaborator Author

I found a project using mkdocs-material and that has the panel: https://mapstore.readthedocs.io/

@effigies
Copy link
Collaborator Author

Found via geosolutions-it/MapStore2#3570, we need to add JQuery. We now get
Screen Shot 2019-05-16 at 10 31 56

I'm going to squash this and merge into master.

@effigies effigies changed the title [INFRA] Update RTD configuration [INFRA] Enable version panel for quickly finding previous versions May 16, 2019
@effigies
Copy link
Collaborator Author

Apparently I can't push fixes to master. Here's to more changelog clutter.

Copy link
Member

@sappelhoff sappelhoff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great effort, thanks @effigies.

Regarding pushing to master: Is your idea that all INFRA changes should be pushed directly to master instead of taking our usual road of going via a PR (see rule 1. in decision-making)?

I don't see an issue with having INFRA PRs in our changelog, but would be happy to discuss it.

@effigies
Copy link
Collaborator Author

I think there should be two changelogs: the repository changelog and the specification changelog. When somebody's reading the spec, what they care about is what new features are there in the specification, and absolutely not what changes were made to the build system.

IMO, the specification changelog should ONLY include [FIX] and [ENH] changes, and should strip out the tags. I also think we should be able to go in and retroactively fix the changelog to be more human friendly without our changes getting destroyed every time a PR gets merged.

@sappelhoff
Copy link
Member

sappelhoff commented May 16, 2019

+1, perhaps you can open an issue on this, because this PR will be merged soon and is a suboptimal place for discussion. Related: #164

@effigies effigies merged commit 4b421c5 into master May 17, 2019
@effigies effigies deleted the rtdtest branch May 17, 2019 15:51
@sappelhoff sappelhoff mentioned this pull request Sep 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable links to other versions of specification
3 participants