-
Notifications
You must be signed in to change notification settings - Fork 465
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
Improve readme and docs #779
Conversation
Any example of a reStructuredText syntax that is not properly rendered in https://github.com/scrapinghub/dateparser and has a Markdown equivalent? I tend to prefer reStructuredText because it allows things that Markdown doesn’t, such as those things you are now implementing in HTML within Markdown. I’m OK with switching to Markdown if Markdown is enough, but if the price is having HTML within Markdown, maybe it’s better to stay with reStructuredText. |
a542f25
to
08905be
Compare
Hi @Gallaecio, I reverted it to use the I added the same HTML raw code, as I wasn't able to get the same result without it, any help on this will be appreciated. On the other sider, opinions about the content, examples, etc. would be also appreciated. Link to preview the current Thanks in advance! 🙂 |
@Gallaecio I have just pushed a commit removing the HTML, but I can't get the expected result (text, image, etc. are not centered). You can see here the version after removing the HTML code: https://github.com/scrapinghub/dateparser/blob/107e1b5026d1bd1a17694bfe237aa7b43b2e5b1b/README.rst the version before (from my last comment): https://github.com/scrapinghub/dateparser/blob/08905be57af1a55e03f27098ea681d29b8cc98c8/README.rst As you can see the HTML version has a better look and feel. Do you know how to fix it? I personally think that |
(FYI: I rechecked it and there is a bug in Github (that's the reason why I mentioned that the Markdown is better supported): github/markup#163). We should probably keep the HTML markup for the logo and the first section). |
Well, if it’s only the alignment I would seriously consider just letting the images align left. But I’m OK with adding the raw HTML for that if you prefer; just add a comment (line starting with |
for: #723
What does this include?
README.md
(moved from rst to markdown because the support is better in Github). I wrote it from scratch. Ideas are welcomed.setup.py
file and update the.travis.yml
to use Python 3 to deploy the package.To preview the
README.md
visit: https://github.com/scrapinghub/dateparser/blob/a542f25e51b6851d8bfd84e82b4c21c53457a716/README.mdTo preview the docs: clone the project, run
tox -e docs
and check theindex.htm
file in../.tox/docs/tmp/html
.Note that the settings need an extra cleanup, but I tried to avoid making too many changes in this PR. It should be fixed later.
On the other side, I don't know how to preview the pypi description.