Skip to content

Better MkDocs integration as GSoC idea #5378

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Mar 1, 2019
Merged

Better MkDocs integration as GSoC idea #5378

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/gsoc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,23 @@ This project would include:
This is not as well defined as the other tasks,
so would require a higher level of skill from an incoming student.

Better MkDocs integration
~~~~~~~~~~~~~~~~~~~~~~~~~

Currently we don't have a good integration with MkDocs as we do with Sphinx.
And it's hard to maintain compatibility with new versions.

This project would include:

* Support the latest version of MkDocs
* Support downloads (`#1939`_)
* Write a plugin to allow us to have more control over the build process (`#4924`_)
* Support search (`#1088`_)

.. _#1939: https://github.com/rtfd/readthedocs.org/issues/1939
.. _#4924: https://github.com/rtfd/readthedocs.org/issues/4924
.. _#1088: https://github.com/rtfd/readthedocs.org/issues/1088

Integrated Redirects
~~~~~~~~~~~~~~~~~~~~

Expand Down