-
Notifications
You must be signed in to change notification settings - Fork 30
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
Removed recommonmark from docs build #457
Conversation
Just a minor fix needed due to flake failure. Do you have a snapshot of the before and after of the documentation? Was wondering if they look the same or if they look different when using m2r as opposed to recommonmark. |
@eemperor This looks good, the docs are generating properly. One more thing to look into would be to switch as much of the rst syntax over to md syntax as we can. Things like:
Can become:
And, also, the two |
6f74132
to
340b8ab
Compare
@lorengordon I updated the link references to markdown format. I changed the rst files to md but left the directive that pulls in markdown files from the parent directory. Seems like a clean way to reference the associated markdown files. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
awesome, merging so we can see how it looks on readthedocs...
@@ -21,7 +21,7 @@ to looking for pypi packages signed with MD5 signatures. If you've enabled FIPS | |||
(or are using a build that has FIPS pre-enabled), MD5 is disabled in the kernel | |||
(due to being a weak hashing-method). You can either disable FIPS (not | |||
recommended) or explicitly force `pip` to use a different signature-index. The | |||
latter is detailed in the Linux section of the :doc:`usage <usage>` document. | |||
latter is detailed in the Linux section of the [usage] (usage.html) document. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops, got a space in there between the bracket and paren: ] (
Open a new pr to fix?
@@ -52,7 +52,7 @@ label may not be related to the error you are encountering. | |||
|
|||
## Does watchmaker support Enterprise Linux 7? | |||
|
|||
Watchmaker is supported on RedHat 7 and CentOS 7. See the :doc:`index <index>` | |||
Watchmaker is supported on RedHat 7 and CentOS 7. See the [index] (index.html) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
space is bad here too
Removed recommonmark from the docs build and updated associated markdown files to directly use the existing restructuredtext format.