Convert docs to reST #62
Conversation
|
Can you make a separate build for it so we can see it? Also, we don't have to forget to change the build settings from mkdocs. |
|
Ah, finally a good looking navigation. Actually message is rather a component than httplug stuff. |
ddeboer
force-pushed
the
sphinx-rest
branch
3 times, most recently
from
0218092 to
a90d26b
Compare
|
wow, that was quick! and looks well on first glance. some random notes: we should make http://php-http.readthedocs.org/en/sphinx-rest/httplug/introduction.html the page that is the HTTPlug main title in the navigation. should plugin be unter HTTPlug or at the same level as HTTPlug? i think we ideally would want all of those as main sections, and drop the two un-linked titles Components and Httplug. it looks like the development section got lost. links need to be adjusted, e.g. http://php-http.readthedocs.org/en/sphinx-rest/plugins.html#install |
|
the mix between anchor links and sub pages is a bit weird on http://php-http.readthedocs.org/en/sphinx-rest/plugins.html - is that normal? or should we make the main plugins page very short and then have an introduction.html that appears on the same level as the plugins? |
ddeboer
force-pushed
the
sphinx-rest
branch
3 times, most recently
from
0359529 to
2c7384a
Compare
|
FOS HTTP cache also have this mixed navigation. |
|
|
ddeboer
force-pushed
the
sphinx-rest
branch
9 times, most recently
from
534b292 to
7649359
Compare
|
This is somewhat inconvenient without the diff views. 😢 Anyway, I fixed most of the issues mentioned above. And the build is finally green. 😉 |
|
The development section seems to be a bit weird. If it has a top level nav, then the subpages are not necessary to be grouped yet another Development nav I think. |
|
Is it possible to make the syntax highlighting similar to what you have on the HTTP Cache docs? Is it configuration or custom style? |
|
Yeah that’s because I needed to differentiate the development group from the components one. I did the syntax highlighting with some custom CSS. Let’s hold off on that for later. |
|
👍 |
|
Is there something we can do about the development section? |
|
@sagikazarmark can you please look at the last section of code-of-conduct.rst? there are "things" there that i think do not look like correct markdown, nor rst. not sure what exactly the idea there was? |
|
@ddeboer is the file docs/css/extra.css relevant? i have the impression its a leftover. we should probably remove it and add a new css when we tweak syntax highlighting. favicon.ico seems also unused, but would make sense to be used. |
| @@ -1,53 +0,0 @@ | |||
| site_name: PHP-HTTP Documentation | |||
There was a problem hiding this comment.
deleted as i think this is obsolete
| # The name of an image file (within the static path) to use as favicon of the | ||
| # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | ||
| # pixels large. | ||
| html_favicon = 'favicon.ico' |
|
okay, i think this should be ready:
i suggest we merge as is and continue tweaking whats online. switching readthedocs to rst killed the markdown documentation that is/was currently live... |
|
Thanks for helping @dbu! Please wait with merging as I'd like to go over everything one more time: I still see some broken Markdown links and other leftovers. By the way, GH support has fixed the diff view. 😉 |
|
yeah, though with this PR its so many moving parts its hard to see. i scanned for the links and fixed what i found. but sure, go over it. but we should merge today, as right now there is no documentation online anymore :-O |
|
|
||
| .. toctree:: | ||
| :hidden: | ||
| :maxdepth: 3 |
There was a problem hiding this comment.
changed this to 3 in the hope that the anchor links would come back when opening a doc page, but they don't. @ddeboer any idea why? otherwise we can switch this back to 2 to avoid surprises.
|
@dbu fixed CoC links. As I can see, the Message Factory became part of the Message section. I have no problem with it, but technically, the message factory contract is not part of the message package. |
|
Agree, we should merge this today. |
| params | ||
| rebase | ||
| Semver | ||
| sexualized |
There was a problem hiding this comment.
Yup, because of the code of conduct.
There was a problem hiding this comment.
Makes sense, but without a context, it's a bit funny. 😄
|
lets merge and discuss the TOC structure in a new issue (what goes under components, message factory and message, ...) |
|
Yay, docs are back up. 😉 |
Fix #59.