Skip to content

Commit 13351a5

Browse files
authored
Merge pull request readthedocs#5378 from stsewd/gsoc-mkdocs-support
Better MkDocs integration as GSoC idea
2 parents b79606b + 6b5a554 commit 13351a5

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
@@ -128,6 +128,23 @@ This project would include:
128128
This is not as well defined as the other tasks,
129129
so would require a higher level of skill from an incoming student.
130130

131+
Better MkDocs integration
132+
~~~~~~~~~~~~~~~~~~~~~~~~~
133+
134+
Currently we don't have a good integration with MkDocs as we do with Sphinx.
135+
And it's hard to maintain compatibility with new versions.
136+
137+
This project would include:
138+
139+
* Support the latest version of MkDocs
140+
* Support downloads (`#1939`_)
141+
* Write a plugin to allow us to have more control over the build process (`#4924`_)
142+
* Support search (`#1088`_)
143+
144+
.. _#1939: https://github.com/rtfd/readthedocs.org/issues/1939
145+
.. _#4924: https://github.com/rtfd/readthedocs.org/issues/4924
146+
.. _#1088: https://github.com/rtfd/readthedocs.org/issues/1088
147+
131148
Integrated Redirects
132149
~~~~~~~~~~~~~~~~~~~~
133150

0 commit comments

Comments
 (0)