docs: Add switchable tabs between pixi.toml and pyproject.toml where applicable #4528
Conversation
david-dorf
changed the title
There was a problem hiding this comment.
Hey, we use the snippets to run tests on the files. This allows us to make sure these snippets will be parsable.
It would be better if we could solve this with a script that would take the pixi.toml as source and output the pyproject.toml version. Otherwise it would be lots of extra work for us to maintain this.
Would you be willing to take a look at that?
|
I used the style I saw in other switchable tabs in the docs, but I agree it is a pain to maintain. I was thinking of a Python script that inserts "tool.pixi." on each section for the pyproject.toml. I think there are some exceptions like how default dependencies, etc are handled. If that sounds alright I can try to come up with something and have it run wherever the rest of the docs building workflow is. |
|
@david-dorf I think that would be a good idea, It's best if the script would do the base work and where there is special behavior we can still take over. |
|
Maybe for now I could add the snippets I added for pyproject.toml tabs into prefix-dev/pixi/tree/main/docs/source_files/pyproject_tomls? I think a short script to generate the pyproject.toml sections in the future is distinct enough for a separate issue/pr |
3 participants
Addresses #4452