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

Open
stsewd opened this issue Nov 26, 2018 · 3 comments

Comments

@stsewd
Copy link
Member

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

@pranay414

This comment has been minimized.

Copy link
Contributor

commented Jul 19, 2019

@stsewd Can I work on this?

@dojutsu-user

This comment has been minimized.

Copy link
Member

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

This comment has been minimized.

Copy link
Contributor

commented Jul 19, 2019

Oh okay!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.