Merge pull request #892 from openfisca/update-doc-links

Update doc links in API

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+### 34.2.8 [#892](https://github.com/openfisca/openfisca-core/pull/892)
+
+#### Documentation
+
+- Update links to the doc in the API
+
 ### 34.2.7 [#886](https://github.com/openfisca/openfisca-core/pull/885)
 
 #### Minor change

openfisca_core/entities.py

@@ -23,6 +23,7 @@ class Entity(object):
     """
         Represents an entity (e.g. a person, a household, etc.) on which calculations can be run.
     """
+
     def __init__(self, key, plural, label, doc):
         self.key = key
         self.label = label
@@ -58,6 +59,7 @@ class GroupEntity(Entity):
     """
         Represents an entity composed of several persons with different roles, on which calculations are run.
     """
+
     def __init__(self, key, plural, label, doc, roles):
         super().__init__(key, plural, label, doc)
         self.roles_description = roles

openfisca_web_api/openAPI.yml

@@ -3,9 +3,9 @@ info:
   title: "{COUNTRY_PACKAGE_NAME} Web API"
   description: "The OpenFisca Web API lets you get up-to-date information and formulas included in the {COUNTRY_PACKAGE_NAME} legislation."
   version: null
-  termsOfService: "https://openfisca.org/doc/publishing"
+  termsOfService: "https://openfisca.org/doc/licence.html"
   contact:
-    email: "contact@openfisca.fr"
+    email: "contact@openfisca.org"
   license:
     name: "AGPL"
     url: "https://www.gnu.org/licenses/agpl-3.0"
@@ -16,17 +16,17 @@ tags:
     description: "A parameter is a numeric property of the legislation that can evolve over time."
     externalDocs:
       description: "Parameters documentation"
-      url: "https://openfisca.org/doc/parameters"
+      url: "https://openfisca.org/doc/key-concepts/parameters.html"
   - name: "Variables"
     description: "A variable depends on a person, or an entity (e.g. zip code, salary, income tax)."
     externalDocs:
       description: "Variables documentation"
-      url: "https://openfisca.org/doc/variables"
+      url: "https://openfisca.org/doc/key-concepts/variables.html"
   - name: "Entities"
     description: "An entity is a person of a group of individuals (such as a household)."
     externalDocs:
       description: "Entities documentation"
-      url: "https://openfisca.org/doc/person,_entities,_role.html"
+      url: "https://openfisca.org/doc/key-concepts/person,_entities,_role.html"
   - name: "Calculations"
   - name: "Documentation"
 paths:
@@ -43,7 +43,7 @@ paths:
       parameters:
       - in: "body"
         name: "Situation"
-        description: 'Describe the situation (persons and entities). Add the variable you wish to calculate in the proper entity, with null as the value. Learn more in our official documentation: https://openfisca.org/doc/openfisca-web-api/input-output-data'
+        description: 'Describe the situation (persons and entities). Add the variable you wish to calculate in the proper entity, with null as the value. Learn more in our official documentation: https://openfisca.org/doc/openfisca-web-api/input-output-data.html'
         required: true
         schema:
           $ref: '#/definitions/SituationInput'

setup.py

@@ -37,7 +37,7 @@
 
 setup(
     name = 'OpenFisca-Core',
-    version = '34.2.7',
+    version = '34.2.8',
     author = 'OpenFisca Team',
     author_email = 'contact@openfisca.org',
     classifiers = [
@@ -58,7 +58,10 @@
         ('share/openfisca/openfisca-core', ['CHANGELOG.md', 'LICENSE', 'README.md']),
         ],
     entry_points = {
-        'console_scripts': ['openfisca=openfisca_core.scripts.openfisca_command:main', 'openfisca-run-test=openfisca_core.scripts.openfisca_command:main'],
+        'console_scripts': [
+            'openfisca=openfisca_core.scripts.openfisca_command:main',
+            'openfisca-run-test=openfisca_core.scripts.openfisca_command:main',
+            ],
         },
     extras_require = {
         'web-api': api_requirements,