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

Create a plugin for mkdocs integration as we do with Sphinx #4924

Closed
stsewd opened this issue Nov 26, 2018 · 4 comments
Closed

Create a plugin for mkdocs integration as we do with Sphinx #4924

stsewd opened this issue Nov 26, 2018 · 4 comments
Labels
Feature Needed: design decision

Comments

@stsewd
Copy link
Member

@stsewd stsewd commented Nov 26, 2018

Probably this would be a very low priority but I wanted to put it here so we don't forget.

Currently, we inject some values on the mkdocs config file

https://github.com/rtfd/readthedocs.org/blob/c37b00995c1bbc5ee51d3552ef176546373bb912/readthedocs/doc_builder/backends/mkdocs.py#L107-L169

This is a problem when mkdocs make incompatible changes between versions, if we write an extension we can have more control over this.

Related #4820 #4827

Docs about writing plugins https://www.mkdocs.org/user-guide/plugins/#developing-plugins

@stsewd stsewd added Feature Needed: design decision labels Nov 26, 2018
@humitos humitos added this to the Low priority features we want milestone Nov 28, 2018
@pranay414
Copy link
Contributor

@pranay414 pranay414 commented Jul 19, 2019

@stsewd Can I work on this?

@dojutsu-user
Copy link
Member

@dojutsu-user dojutsu-user commented Jul 19, 2019

Hi @pranay414
Thanks for your interest in contribution.
This issue has a Feature tag -- https://docs.readthedocs.io/en/latest/roadmap.html?highlight=feature#triaging-issues

I would suggest to pick any other issue for now.

@pranay414
Copy link
Contributor

@pranay414 pranay414 commented Jul 19, 2019

Oh okay!

@humitos
Copy link
Member

@humitos humitos commented Jan 27, 2022

I think we decided we are not going to do this work anytime soon, at least.

@humitos humitos closed this as completed Jan 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature Needed: design decision
Projects
None yet
Development

No branches or pull requests

4 participants