From 07adee3c51389eb85b4d515b772df9b2f1b7ee0a Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Mon, 21 Sep 2020 22:44:48 +1000 Subject: [PATCH] Update links to documenation --- CONTRIBUTING.md | 9 ++++----- InvenTree/part/templatetags/inventree_extras.py | 2 +- InvenTree/part/test_part.py | 2 +- 3 files changed, 6 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 046826c928..1024e251c1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ No pushing to master! New featues must be submitted in a separate branch (one br ## Include Migration Files -Any required migration files **must** be included in the commit, or the pull-request will be rejected. If you change the underlying database schema, make sure you run `make migrate` and commit the migration files before submitting the PR. +Any required migration files **must** be included in the commit, or the pull-request will be rejected. If you change the underlying database schema, make sure you run `invoke migrate` and commit the migration files before submitting the PR. ## Update Translation Files @@ -14,7 +14,7 @@ Any PRs which update translatable strings (i.e. text strings that will appear in *This does not mean that all translations must be provided, but that the translation files must include locations for the translated strings to be written.* -To perform this step, simply run `make_translate` from the top level directory before submitting the PR. +To perform this step, simply run `invoke translate` from the top level directory before submitting the PR. ## Testing @@ -22,9 +22,8 @@ Any new code should be covered by unit tests - a submitted PR may not be accepte ## Documentation -New features or updates to existing features should be accompanied by user documentation. -A PR with associated documentation should link to the matching PR at https://github.com/inventree/InvenTree.github.io +New features or updates to existing features should be accompanied by user documentation. A PR with associated documentation should link to the matching PR at https://github.com/inventree/inventree-docs/ ## Code Style -Sumbitted Python code is automatically checked against PEP style guidelines. Locally you can run `make style` to ensure the style checks will pass, before submitting the PR. +Sumbitted Python code is automatically checked against PEP style guidelines. Locally you can run `invoke style` to ensure the style checks will pass, before submitting the PR. diff --git a/InvenTree/part/templatetags/inventree_extras.py b/InvenTree/part/templatetags/inventree_extras.py index f7bf65abc0..3eca883aea 100644 --- a/InvenTree/part/templatetags/inventree_extras.py +++ b/InvenTree/part/templatetags/inventree_extras.py @@ -83,7 +83,7 @@ def inventree_github_url(*args, **kwargs): @register.simple_tag() def inventree_docs_url(*args, **kwargs): """ Return URL for InvenTree documenation site """ - return "https://inventree.github.io" + return "https://inventree.readthedocs.io/" @register.simple_tag() diff --git a/InvenTree/part/test_part.py b/InvenTree/part/test_part.py index de2edcec98..97330f1ced 100644 --- a/InvenTree/part/test_part.py +++ b/InvenTree/part/test_part.py @@ -35,7 +35,7 @@ class TemplateTagTest(TestCase): self.assertIn('github.com', inventree_extras.inventree_github_url()) def test_docs(self): - self.assertIn('inventree.github.io', inventree_extras.inventree_docs_url()) + self.assertIn('inventree.readthedocs.io', inventree_extras.inventree_docs_url()) class PartTest(TestCase):