Skip to content

Core documentation converted to Markdown format prepared for merge. Check summary.#1216

Merged
insspb merged 44 commits intocookiecutter:masterfrom
insspb:docs_merge
Sep 25, 2019
Merged

Core documentation converted to Markdown format prepared for merge. Check summary.#1216
insspb merged 44 commits intocookiecutter:masterfrom
insspb:docs_merge

Conversation

@insspb
Copy link
Copy Markdown
Member

@insspb insspb commented Aug 27, 2019

First of all. Thanks to @wagnernegrao for his great work at the footprint of this poll request. I just fixed some places to make our documentation available in Sphinx and Github pages at the same time.

Here is a summary for this pull request from both of us:

  • AUTHORS.rst from root folder converted to AUTHORS.md.
    Authors list synced on August 27, 2019
  • AUTHORS.rst from docs folder replaced with a symlink to AUTHORS.md in the root folder. It is possible to configure Sphinx to render documents outside the docs folder, but in case of MarkDown formatting, it will break documentation rendering.
  • BACKERS.rst from root folder converted to BACKERS.md.
  • BACKERS.md added to Sphix documentation via a symlink
  • CONTRIBUTING.rst from root folder converted to CONTRIBUTING.md
  • contributing.rst from docs folder replaced with a symlink to CONTRIBUTING.md from the root folder. The reasons are the same as with AUTHORS.rst and all other replaced files from docs folder.
  • contributing.rst, contributor_guidelines.rst, contributor_setup.rst, contributor_testing.rst files from docs folder removed. This will change a little bit how Contribution guide displayed in Sphinx doc. But now we need to update guide in one place and it will work everywhere.
  • Make file update at the core - as we do not render contributing from several files, this target removed.
  • Information of this target is also removed from contributions guide.
  • HISTORY.rst from root folder converted to HISTORY.md
    History synced on August 27, 2019
  • history.rst from docs folder replaced with a symlink to HISTORY.md in the root folder.
  • README.rst converted to README.md in the root folder, added as a symlink to docs folder.
  • case_studies.rst converted to case_studies.md in the root folder, added as a symlink to docs folder.
  • .pre-commit-config.yaml updated:
    • Now it ignores markdown hard newlines (double space at the end of the line)
    • As we now use symlinks it will check that every symlink works.
  • All MD files passed markdown lint
  • All MD files are formated at the same style way. (Long lines, asterisks as unordered lists, ordered lists with all numbers, no bare-links allowed, all links in the same format)
  • docs/conf.py and docs/requirements.txt - Include new render configuration and some changes to pass lint tests.
  • docs/conf.py - Copyright and year update
  • docs/index.rst and docs/installation.rst - Links are in CAPS symbols. This required to make links works in Github and in Sphinx at the same time.
  • setup.py - update to use Markdown for description.

Fuh, it was a long night :)

@hackebrot
Copy link
Copy Markdown
Member

I did not have time to review this pull-request.

@insspb
Copy link
Copy Markdown
Member Author

insspb commented Sep 3, 2019

I hate appveyor. All the problem was in outdated versions in tox notation.
I updated tox requirements to current, and now it is green and will not break our CI/CD
Ready for merge.

@ssbarnea
Copy link
Copy Markdown
Member

ssbarnea commented Sep 3, 2019

Thanks! Lets merge it.

Copy link
Copy Markdown
Contributor

@michaeljoseph michaeljoseph left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks pretty good to me.
Epic effort 💪 🙌

@michaeljoseph michaeljoseph removed their assignment Sep 8, 2019
@insspb insspb requested a review from michaeljoseph September 8, 2019 20:42
@ssbarnea
Copy link
Copy Markdown
Member

ssbarnea commented Sep 19, 2019

🚀 SHIP IT!

@insspb insspb merged commit 673f773 into cookiecutter:master Sep 25, 2019
@insspb
Copy link
Copy Markdown
Member Author

insspb commented Sep 25, 2019

Merged after one month of review :)
@wagnernegrao congratulations, thank you.

@Bhupesh-V
Copy link
Copy Markdown

I think the issue (#1062) was accidentally ignored in this PR.

I had the same errors while running make servedocs.
Got fixed when I installed the dependencies mentioned in #1126.

Should I create a new issue/PR for this ?

@insspb
Copy link
Copy Markdown
Member Author

insspb commented Jun 5, 2020

@Bhupesh-V If yoou have any issue anywhere you always should create new issue and PR, and never try to use old ones. As mentioned issue was related to version 1.6.0. (2 years ago)

@insspb insspb mentioned this pull request Jun 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation This issue/PR relates to or includes documentation. high-priority needs-review PR Only: This PR require review from other developer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants