Skip to content

Commit 6b5a554

Browse files
committed
Better MkDocs integration as GSoC idea
1 parent a98aac4 commit 6b5a554

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/gsoc.rst

+17
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,23 @@ This project would include:
115115
This is not as well defined as the other tasks,
116116
so would require a higher level of skill from an incoming student.
117117

118+
Better MkDocs integration
119+
~~~~~~~~~~~~~~~~~~~~~~~~~
120+
121+
Currently we don't have a good integration with MkDocs as we do with Sphinx.
122+
And it's hard to maintain compatibility with new versions.
123+
124+
This project would include:
125+
126+
* Support the latest version of MkDocs
127+
* Support downloads (`#1939`_)
128+
* Write a plugin to allow us to have more control over the build process (`#4924`_)
129+
* Support search (`#1088`_)
130+
131+
.. _#1939: https://github.com/rtfd/readthedocs.org/issues/1939
132+
.. _#4924: https://github.com/rtfd/readthedocs.org/issues/4924
133+
.. _#1088: https://github.com/rtfd/readthedocs.org/issues/1088
134+
118135
Integrated Redirects
119136
~~~~~~~~~~~~~~~~~~~~
120137

0 commit comments

Comments
 (0)