Skip to content
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

Update description of supplier #1231

Closed
wants to merge 32 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
733f6a8
Updating requirements for myst-parser
choldgraf Feb 1, 2021
d5c466c
Using MyST markdown eval-rst directive
choldgraf Feb 1, 2021
fc1cdcb
Updating header metadata to MyST syntax
choldgraf Feb 1, 2021
3e19828
Converting index page to MyST
choldgraf Feb 1, 2021
b4ad655
Fixing markdown header levels
choldgraf Feb 2, 2021
c1ab0a7
conf: Disable dollarmath
jpmckinney Feb 5, 2021
9b542ba
Fixing references to downloadable JSON files.
choldgraf Feb 12, 2021
bd0e2e6
Merge branch 'myst-parser-switch' of https://github.com/choldgraf/sta…
choldgraf Feb 12, 2021
667b4e8
Pinning Sphinx to commit to avoid header level error.
choldgraf Feb 12, 2021
2c6150d
Updating MDIt-py plugins for bugfix.
choldgraf Feb 12, 2021
f72e811
Properly linking another JSON file.
choldgraf Feb 12, 2021
e76a6ba
Disabling a CI test that fails because of MyST.
choldgraf Feb 12, 2021
bd80cda
requirements: Update sphinxcontrib-opencontracting
jpmckinney Feb 6, 2021
3e53bfa
Cherry-pick #1204
jpmckinney Feb 6, 2021
34cae48
requirements: Add pip-tools. Remove commonmark.
jpmckinney Feb 14, 2021
da298b5
make: Use stricter sphinx-build arguments
jpmckinney Feb 14, 2021
0a10057
build: Exclude _downloads directory from add_translation_notes.py
jpmckinney Feb 14, 2021
cb1ad9c
Use field-description and code-description directives
jpmckinney Feb 6, 2021
ae337bd
requirements: Update sphinxcontrib-opencontracting
jpmckinney Feb 14, 2021
a474afa
conf: Remove extension_versions config value
jpmckinney Feb 14, 2021
21383b2
Merge pull request #1213 from open-contracting/myst-parser-switch
jpmckinney Feb 14, 2021
e6b6c82
Cherry-pick from #1205
JachymHercher Feb 7, 2021
121488e
Merge pull request #1223 from open-contracting/396-electronic-catalog…
jpmckinney Feb 17, 2021
9c6ced6
master -> main open-contracting/standard-maintenance-scripts#158
jpmckinney Feb 20, 2021
8885a3f
Update to latest profile template
jpmckinney Feb 20, 2021
9cc5e8f
md: Fix MyST-Parser syntax
jpmckinney Feb 20, 2021
62f44ab
build: Update to latest profile template
jpmckinney Feb 20, 2021
39347c9
Use latest branch for profiles
jpmckinney Feb 20, 2021
b2477e0
Merge pull request #1224 from open-contracting/master-to-main
jpmckinney Feb 22, 2021
e94b8fc
Adding new role to build a team
odscrachel Feb 24, 2021
f7a466d
Merge pull request #1227 from open-contracting/build_team_role
odscrachel Feb 24, 2021
802c577
Update partyRole.csv
JachymHercher Feb 28, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,23 +23,26 @@ jobs:
# https://help.github.com/en/actions/reference/software-installed-on-github-hosted-runners
- name: Make
run: |
if [ $GITHUB_REPOSITORY = 'open-contracting/standard_profile_template' ]; then python schema/build-profile.py; make extract; fi
if [ $GITHUB_REPOSITORY = 'open-contracting/standard_profile_template' ]; then
python schema/build-profile.py
make extract
fi
make
python util/add_translation_notes.py
- run: pytest
- uses: shimataro/ssh-key-action@v2
with:
key: ${{ secrets.PRIVATE_KEY }}
known_hosts: standard.open-contracting.org ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDWLziEiV46d9iInFXAR/PxPvotcpmMtbwO8GkTF2/AFUkyiSd8/Yg5HXUoWBz7hbRwg2O+q5F1QfD57vevBV7c+JKyBbKVOi/mXaf7uACxer419RTgKcpaMhNRi708XWhNlWiKp3Afs/MDMvMdWSrU+Ht7biNb1OMGjfNMDdlsJxPycxMQ7Fu7i+kdyMkKLYDIHNeEw0aW9PtMTReUE0y/Ghn44PDR2u9/oZsEhC0ELDQUfsjtCcoM91FH1tjRBZkOW/j5940nMoJpbVhFHTC3YY9Mh2kV+N6Whht5nghJ7Jl2vN5W0Uer+TNMVRV4QMu8xK5HXbjKFMpaK+j4gBs9
- uses: little-core-labs/netrc-creds@v2.0.1
- uses: little-core-labs/netrc-creds@v2.1.0
with:
creds: |
[{
"machine": "standard.open-contracting.org",
"login": "manage",
"password": "${{ secrets.ELASTICSEARCH_PASSWORD }}"
}]
machine: standard.open-contracting.org
login: manage
password: ${{ secrets.ELASTICSEARCH_PASSWORD }}
- if: success()
env:
PATH_PREFIX: ''
run: curl -Ss https://raw.githubusercontent.com/open-contracting/deploy/master/deploy-docs.sh | bash -
run: |
if [ $GITHUB_REPOSITORY != 'open-contracting/standard_profile_template' ]; then
curl -sS https://raw.githubusercontent.com/open-contracting/deploy/main/deploy-docs.sh | bash -
fi
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Lint
on: [push, pull_request]
env:
BASEDIR: https://raw.githubusercontent.com/open-contracting/standard-maintenance-scripts/master
BASEDIR: https://raw.githubusercontent.com/open-contracting/standard-maintenance-scripts/main
jobs:
build:
runs-on: ubuntu-latest
Expand Down
7 changes: 4 additions & 3 deletions common-requirements.in
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Sphinx<3
-e git+https://github.com/sphinx-doc/sphinx.git@3207da1fa81a5d3171d3bbb15768e1c6f6b39b58#egg=sphinx

# Sphinx
ocds-babel>=0.2.1
# See https://ocds-babel.readthedocs.io/en/latest/api/translate.html#install-requirements-for-markdown-translation
-e git+https://github.com/readthedocs/commonmark.py.git@dafae75015cc342f3fddb499674bab97ac4a6a96#egg=commonmark
-e git+https://github.com/jpmckinney/recommonmark.git@hotfix#egg=recommonmark
-e git+https://github.com/open-contracting/standard_theme.git@open_contracting#egg=standard_theme
myst-parser~=0.13.3
mdit-py-plugins~=0.2.5

# Make
sphinx-intl<1
Expand All @@ -18,5 +18,6 @@ ocdsindex>=0.0.4
ocdsextensionregistry>=0.0.23

# Tests
pip-tools
pytest
selenium
39 changes: 27 additions & 12 deletions common-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,19 @@
#
# pip-compile common-requirements.in
#
-e git+https://github.com/readthedocs/commonmark.py.git@dafae75015cc342f3fddb499674bab97ac4a6a96#egg=commonmark
-e git+https://github.com/sphinx-doc/sphinx.git@3207da1fa81a5d3171d3bbb15768e1c6f6b39b58#egg=sphinx
# via
# -r common-requirements.in
# recommonmark
-e git+https://github.com/jpmckinney/recommonmark.git@hotfix#egg=recommonmark
# via -r common-requirements.in
# myst-parser
# sphinx-intl
-e git+https://github.com/open-contracting/standard_theme.git@open_contracting#egg=standard_theme
# via -r common-requirements.in
alabaster==0.7.12
# via sphinx
attrs==19.3.0
# via pytest
# via
# markdown-it-py
# pytest
babel==2.8.0
# via
# sphinx
Expand All @@ -29,10 +30,11 @@ chardet==3.0.4
click==7.0
# via
# ocdsindex
# pip-tools
# sphinx-intl
docutils==0.16
# via
# recommonmark
# myst-parser
# sphinx
elasticsearch==7.10.1
# via ocdsindex
Expand All @@ -45,17 +47,30 @@ importlib-metadata==1.4.0
# pluggy
# pytest
jinja2==2.10.3
# via sphinx
# via
# myst-parser
# sphinx
json-merge-patch==0.2
# via ocdsextensionregistry
jsonref==0.2
# via ocdsextensionregistry
lxml==4.6.2
# via ocdsindex
markdown-it-py==0.6.1
# via
# mdit-py-plugins
# myst-parser
markupsafe==1.1.1
# via jinja2
mdit-py-plugins==0.2.5
# via
# -r common-requirements.in
# markdown-it-py
# myst-parser
more-itertools==8.1.0
# via pytest
myst-parser==0.13.3
# via -r common-requirements.in
ocds-babel==0.2.1
# via -r common-requirements.in
ocdsextensionregistry==0.0.23
Expand All @@ -66,6 +81,8 @@ packaging==20.0
# via
# pytest
# sphinx
pip-tools==5.5.0
# via -r common-requirements.in
pluggy==0.13.1
# via pytest
py==1.8.1
Expand All @@ -80,6 +97,8 @@ python-slugify==1.2.6
# via transifex-client
pytz==2019.3
# via babel
pyyaml==5.4.1
# via myst-parser
requests-cache==0.5.2
# via ocdsextensionregistry
requests==2.22.0
Expand All @@ -99,11 +118,6 @@ snowballstemmer==2.0.0
# via sphinx
sphinx-intl==0.9.12
# via -r common-requirements.in
sphinx==2.4.4
# via
# -r common-requirements.in
# recommonmark
# sphinx-intl
sphinxcontrib-applehelp==1.0.1
# via sphinx
sphinxcontrib-devhelp==1.0.1
Expand Down Expand Up @@ -132,4 +146,5 @@ zipp==1.0.0
# via importlib-metadata

# The following packages are considered to be unsafe in a requirements file:
# pip
# setuptools
6 changes: 3 additions & 3 deletions docs/404.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
```eval_rst
:orphan:
```
---
orphan: true
---

# 404 Not found

Expand Down
5 changes: 5 additions & 0 deletions docs/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@ div.spaced li {
margin-bottom: 1em;
}

.directive--field-description,
.directive--code-description {
font-style: italic;
}

/* Extensions */
.hide {
display: none;
Expand Down
2 changes: 1 addition & 1 deletion docs/_static/extensions.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ if (document.querySelector('.extension_list')) {

// Get the community extensions to add to the documentation.
const request = new XMLHttpRequest()
request.open('GET', 'https://raw.githubusercontent.com/open-contracting/extension_registry/master/build/extensions.json')
request.open('GET', 'https://raw.githubusercontent.com/open-contracting/extension_registry/main/build/extensions.json')
request.responseType = 'json'

request.onload = () => {
Expand Down
17 changes: 6 additions & 11 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@

import standard_theme
from ocds_babel.translate import translate
from recommonmark.transform import AutoStructify

# -- Project information -----------------------------------------------------

Expand All @@ -37,10 +36,10 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'recommonmark',
'sphinxcontrib.jsonschema',
'sphinxcontrib.opencontracting',
'sphinxcontrib.opendataservices',
'myst_parser',
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -91,7 +90,7 @@
gettext_domain_prefix = ''

# List the extension identifiers and versions that should be part of the standard. The extensions must be available in
# the extension registry: https://github.com/open-contracting/extension_registry/blob/master/extension_versions.csv
# the extension registry: https://github.com/open-contracting/extension_registry/blob/main/extension_versions.csv
default_extension_version = 'v{}'.format(release)
extension_versions = {
'bids': default_extension_version,
Expand All @@ -103,16 +102,12 @@
'process_title': default_extension_version,
}

# Disable dollarmath, which uses MathJax for a string like: "If Alice has $100 and Bob has $1..."
# https://myst-parser.readthedocs.io/en/latest/using/intro.html#sphinx-configuration-options
myst_enable_extensions = []

def setup(app):
app.add_config_value('extension_versions', extension_versions, True)
app.add_config_value('recommonmark_config', {
'auto_toc_tree_section': 'Contents',
'enable_eval_rst': True
}, True)

app.add_transform(AutoStructify)

def setup(app):
# The root of the repository.
basedir = Path(os.path.realpath(__file__)).parents[1]
# The `LOCALE_DIR` from `config.mk`.
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/extended.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"version": "1.1",
"extensions": [
"https://raw.githubusercontent.com/open-contracting/ocds_participationFee_extension/master/extension.json"
"https://raw.githubusercontent.com/open-contracting-extensions/ocds_participationFee_extension/master/extension.json"
],
"releases": [
{
Expand Down
30 changes: 15 additions & 15 deletions docs/getting_started/building_blocks.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Building Blocks
# Building Blocks

In mapping your data to OCDS, or using OCDS data, you will encounter a number of common data structures.

Expand All @@ -12,7 +12,7 @@ In mapping your data to OCDS, or using OCDS data, you will encounter a number of
</tr>
</table>

### Sections and structure
## Sections and structure

An OCDS document is made up of a number of sections. These are:

Expand All @@ -26,7 +26,7 @@ An OCDS document is made up of a number of sections. These are:

These are represented in a JSON document as follows:

```eval_rst
```{eval-rst}
.. code-block:: json
:emphasize-lines: 8-13

Expand All @@ -48,7 +48,7 @@ These are represented in a JSON document as follows:
}
```

### Building blocks: fields
## Building blocks: fields

The OCDS schema sets out the fields that ought to be included in each section (where applicable), making use of simple re-usable building blocks (field structures) to represent data.

Expand All @@ -61,57 +61,57 @@ For example, common building blocks are provided for:
* **Documents**
* **Milestones**

#### Examples
### Examples

```eval_rst
```{eval-rst}
.. jsoninclude:: ../examples/record.json
:jsonpointer: /records/0/compiledRelease/parties/0
:expand: identifier, address, contactPoint
:title: party

```

```eval_rst
```{eval-rst}
.. jsoninclude:: ../examples/record.json
:jsonpointer: /records/0/compiledRelease/awards/0/value
:expand:
:title: amounts

```

```eval_rst
```{eval-rst}
.. jsoninclude:: ../examples/record.json
:jsonpointer: /records/0/compiledRelease/awards/0/items
:expand: classification, unit, additionalClassifications, value
:title: items

```

```eval_rst
```{eval-rst}
.. jsoninclude:: ../examples/record.json
:jsonpointer: /records/0/compiledRelease/awards/0/contractPeriod
:expand:
:title: period

```

```eval_rst
```{eval-rst}
.. jsoninclude:: ../examples/record.json
:jsonpointer: /records/0/compiledRelease/awards/0/documents
:expand:
:title: documents

```

```eval_rst
```{eval-rst}
.. jsoninclude:: ../examples/record.json
:jsonpointer: /records/0/compiledRelease/tender/milestones/0
:expand:
:title: milestones

```

#### Using building blocks
### Using building blocks

These building blocks can be used in various different sections. For example, **items** can occur in tender (to indicate the items that a buyer wishes to buy), in an award object (to indicate the items that an award has been made for) and in a contract object (to indicate the items listed in the contract).

Expand All @@ -125,7 +125,7 @@ In addition to these building blocks, the OCDS schema sets out the specific ways

Many of these fields make use of lightweight codelists provided by OCDS.

#### Extensions
### Extensions

In some cases, publishers or users need building blocks and fields which are not provided in the core OCDS schema.

Expand All @@ -139,7 +139,7 @@ The Open Contracting Data Standard helpdesk maintain a [field-level mapping temp

</div>

### Codelists
## Codelists

OCDS defines two kinds of codelist:

Expand All @@ -165,7 +165,7 @@ In the EU, contracts can be initiated through a number of different procedures i

However, to support comparison across continents, the main OCDS procurement method codelist is a closed codelist with four values:

```eval_rst
```{eval-rst}
.. codelisttable::
:header-rows: 1
:file: ../../build/current_lang/codelists/method.csv
Expand Down
Loading