Nikhil Ramakrishnan pushed to branch update-deps at FreeType / docwriter
Commits:
-
ffe6125c
by nikramakrishnan at 2021-03-21T17:43:09+05:30
-
e86274c8
by nikramakrishnan at 2021-03-28T00:08:51+05:30
-
e575c72e
by Nikhil Ramakrishnan at 2021-03-27T18:57:48+00:00
-
00c7769f
by nikramakrishnan at 2021-03-28T00:33:49+05:30
-
c2928645
by nikramakrishnan at 2021-03-28T00:33:49+05:30
-
86cef9a2
by nikramakrishnan at 2021-03-28T00:40:41+05:30
24 changed files:
- + .gitlab-ci.yml
- .travis.yml
- CHANGELOG
- README.md
- docs/markdown/stylesheets/extra.css
- docwriter/__main__.py
- docwriter/check.py
- docwriter/content.py
- docwriter/formatter.py
- docwriter/siteconfig.py
- docwriter/sources.py
- docwriter/tomarkdown.py
- docwriter/utils.py
- requirements.txt
- setup.py
- tests/assets/test.c
- tests/freetype.sh
- tests/test_integration.py
- tests/test_parse.py
- tests/test_siteconfig.py
- tests/test_tomarkdown.py
- tests/test_utils.py
- tools/update-copyright-year
- tox.ini
Changes:
1 |
+#
|
|
2 |
+# .gitlab-ci.yml
|
|
3 |
+#
|
|
4 |
+# Gitlab CI build configuration.
|
|
5 |
+#
|
|
6 |
+# Copyright (C) 2021 by
|
|
7 |
+# Nikhil Ramakrishnan.
|
|
8 |
+#
|
|
9 |
+# This file is part of the FreeType project, and may only be used,
|
|
10 |
+# modified, and distributed under the terms of the FreeType project
|
|
11 |
+# license, LICENSE.TXT. By continuing to use, modify, or distribute
|
|
12 |
+# this file you indicate that you have read the license and
|
|
13 |
+# understand and accept it fully.
|
|
14 |
+ |
|
15 |
+.rules-default: &rules-default
|
|
16 |
+ rules:
|
|
17 |
+ - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
|
|
18 |
+ - if: '$CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS'
|
|
19 |
+ when: never
|
|
20 |
+ - if: '$CI_COMMIT_BRANCH'
|
|
21 |
+ - if: '$CI_COMMIT_TAG'
|
|
22 |
+ |
|
23 |
+.tests: &tests
|
|
24 |
+ <<: *rules-default
|
|
25 |
+ before_script:
|
|
26 |
+ - python -V
|
|
27 |
+ - pip install tox
|
|
28 |
+ script:
|
|
29 |
+ - tox
|
|
30 |
+ |
|
31 |
+.regression: ®ression
|
|
32 |
+ <<: *rules-default
|
|
33 |
+ before_script:
|
|
34 |
+ - python -V
|
|
35 |
+ - pip install tox
|
|
36 |
+ - apt-get -qq update && apt-get install -y clang autoconf cmake libtool
|
|
37 |
+ script:
|
|
38 |
+ - tox
|
|
39 |
+ |
|
40 |
+.deploy: &deploy
|
|
41 |
+ before_script:
|
|
42 |
+ - pip install twine
|
|
43 |
+ script:
|
|
44 |
+ - python setup.py sdist bdist_wheel
|
|
45 |
+ - twine upload dist/*
|
|
46 |
+ |
|
47 |
+test-python38:
|
|
48 |
+ <<: *tests
|
|
49 |
+ image: python:3.8
|
|
50 |
+ variables:
|
|
51 |
+ TOXENV: "py38"
|
|
52 |
+ stage: test
|
|
53 |
+ |
|
54 |
+test-python39:
|
|
55 |
+ <<: *tests
|
|
56 |
+ image: python:3.9
|
|
57 |
+ variables:
|
|
58 |
+ TOXENV: "py39"
|
|
59 |
+ stage: test
|
|
60 |
+ |
|
61 |
+test-regression:
|
|
62 |
+ <<: *regression
|
|
63 |
+ image: python:3.8
|
|
64 |
+ variables:
|
|
65 |
+ TOXENV: "regression"
|
|
66 |
+ stage: test
|
|
67 |
+ |
|
68 |
+deploy-PyPI:
|
|
69 |
+ <<: *deploy
|
|
70 |
+ image: python:3.8
|
|
71 |
+ variables:
|
|
72 |
+ TWINE_USERNAME: $PYPI_PRODUCTION_USERNAME
|
|
73 |
+ TWINE_PASSWORD: $PYPI_PRODUCTION_PASSWORD
|
|
74 |
+ rules:
|
|
75 |
+ - if: '$CI_COMMIT_TAG && $CI_PROJECT_PATH == "freetype/docwriter"'
|
|
76 |
+ when: always
|
|
77 |
+ - when: never
|
|
78 |
+ stage: deploy
|
1 | 1 |
#
|
2 | 2 |
# .travis.yml
|
3 | 3 |
#
|
4 |
-# Travis CI build configuration.
|
|
4 |
+# DEPRECATED (see below): Travis CI build configuration.
|
|
5 | 5 |
#
|
6 |
-# Copyright (C) 2018-2020 by
|
|
6 |
+# Copyright (C) 2018-2021 by
|
|
7 | 7 |
# Nikhil Ramakrishnan.
|
8 | 8 |
#
|
9 | 9 |
# This file is part of the FreeType project, and may only be used,
|
... | ... | @@ -12,20 +12,26 @@ |
12 | 12 |
# this file you indicate that you have read the license and
|
13 | 13 |
# understand and accept it fully.
|
14 | 14 |
|
15 |
+#
|
|
16 |
+# Travis CI build configuration is no longer being used. This
|
|
17 |
+# repository is now hosted on gitlab.freedesktop.org/freetype, and
|
|
18 |
+# uses a similar Gitlab CI configuration. See file '.gitlab-ci.yml'.
|
|
19 |
+# This file will be removed in the near future.
|
|
20 |
+#
|
|
21 |
+ |
|
15 | 22 |
language: python
|
16 |
-matrix:
|
|
23 |
+jobs:
|
|
17 | 24 |
include:
|
18 |
- - python: 3.5
|
|
19 |
- env: TOXENV=py35
|
|
20 | 25 |
- python: 3.6
|
21 | 26 |
env: TOXENV=py36
|
22 | 27 |
- python: 3.7
|
23 | 28 |
env: TOXENV=py37
|
24 | 29 |
- python: 3.8
|
25 | 30 |
env: TOXENV=py38
|
31 |
+ - python: 3.9
|
|
32 |
+ env: TOXENV=py39
|
|
26 | 33 |
- os: linux
|
27 | 34 |
language: python
|
28 |
- sudo: required
|
|
29 | 35 |
python: 3.7
|
30 | 36 |
env: TOXENV=regression
|
31 | 37 |
|
... | ... | @@ -35,7 +41,7 @@ matrix: |
35 | 41 |
fast_finish: true
|
36 | 42 |
|
37 | 43 |
# command to install dependencies
|
38 |
-before-install:
|
|
44 |
+before_install:
|
|
39 | 45 |
- if [ "$TOXENV" = "regression" ]; then sudo apt-get -qq update && sudo apt-get install -y clang autoconf cmake libtool; fi
|
40 | 46 |
|
41 | 47 |
install:
|
... | ... | @@ -47,10 +53,10 @@ script: |
47 | 53 |
|
48 | 54 |
deploy:
|
49 | 55 |
provider: pypi
|
50 |
- user: "docwriter-deploy"
|
|
56 |
+ username: "[REMOVED]"
|
|
51 | 57 |
distributions: "sdist bdist_wheel"
|
52 | 58 |
password:
|
53 |
- secure: "tNCnC+AbuVfxzaKcyWODPXB0p+/QnYCe0BMdYOTgr44w4tTHLmV2xN7gAsDqEZyARUi9g/XlJdBNLn/nIgo4XRttk8zE0ago2bHpXNkuMwxoOWtENidlUm7a0jd82+lpS3x0T7afJhPyOL9LwnikUej+izvg9GfJM0rKFF4ND8daksOesOoyJD2W+B4Az2puNUrId7SO21K8ocZ9b3hRJTUbmmO2GSaZ4SUTtbnwGghVkzYZ7045Ut64Zzion+8vgpDz6nkbsZH89cjoR5upVGCsDrad4CA/kO/x1wbVAb118mYhWLg3/Nxls9x5QGDOYamdZyPzliNqaqzrHTJHEzvClR6cLMpzICcge969J9mz8g2uXI0RUWJso1MSVYBh31tBfMRKk8+WtLFm2cGq/nrCct7++35Hlpvd242YRxJyV062k4ay2PZdtX66HA1lDk5PCujLBpES9H8bTIc4KeX0naK8UWr5NnV7r2NKvogZouUvd03nD73cripnub/9Tbv2KkXoe55QVOuC51p+mECMzfPsTWXp4PhRfv3hQLHyR0IPOL//spq4gkT+10CYuMwii7tNm8ppuNc/2n+W9imYbg7SHdUUNeIqy1F+fOB1rfKNR5GcGj5tXrHN7qydsMZzl3BYQ8F02Ti79wibs8QlocCOwh4SwT4ZEKMFua0="
|
|
59 |
+ secure: "[REMOVED]"
|
|
54 | 60 |
on:
|
55 | 61 |
tags: true
|
56 | 62 |
repo: freetype/docwriter
|
1 | 1 |
master
|
2 | 2 |
|
3 | 3 |
* Add regression tests.
|
4 |
+ * [Security] Bump pyyaml from 5.3.1 to 5.4.1.
|
|
5 |
+ * Update to mkdocs-material 7.0.6.
|
|
4 | 6 |
|
5 | 7 |
docwriter-1.3 (2020-03-21)
|
6 | 8 |
|
... | ... | @@ -15,7 +15,7 @@ Python >= 3.5 to run. |
15 | 15 |
1. Ensure `docwriter` is installed using `pip`.
|
16 | 16 |
|
17 | 17 |
2. Clone the freetype2 repository from
|
18 |
- [here](http://git.savannah.gnu.org/cgit/freetype/freetype2.git/).
|
|
18 |
+ [here](https://gitlab.freedesktop.org/freetype/freetype.git).
|
|
19 | 19 |
|
20 | 20 |
3. The FreeType build system can be used to generate the docs:
|
21 | 21 |
|
... | ... | @@ -28,12 +28,12 @@ Python >= 3.5 to run. |
28 | 28 |
4. Alternatively, step 1 and the make target can be replaced with `make refdoc-venv`. This installs
|
29 | 29 |
all requirements automatically in a separate virtual environment. More information on
|
30 | 30 |
`virtualenv` usage can be found
|
31 |
- [here](http://git.savannah.gnu.org/cgit/freetype/freetype2.git/tree/docs/README).
|
|
31 |
+ [here](https://gitlab.freedesktop.org/freetype/freetype/-/blob/master/docs/README).
|
|
32 | 32 |
|
33 | 33 |
## Development Usage
|
34 | 34 |
1. Clone this repository.
|
35 | 35 |
2. Clone the freetype2 repository from
|
36 |
- [here](http://git.savannah.gnu.org/cgit/freetype/freetype2.git/).
|
|
36 |
+ [here](https://gitlab.freedesktop.org/freetype/freetype.git).
|
|
37 | 37 |
3. Run `pip install -r requirements.txt` in your environment (`virtualenv` recommended).
|
38 | 38 |
4. Copy the `include/` directory from `freetype2` to `docwriter`.
|
39 | 39 |
5. Run in the `docwriter` directory:
|
... | ... | @@ -103,7 +103,7 @@ More information on running specific tox environments can be found |
103 | 103 |
### Regression Tests
|
104 | 104 |
|
105 | 105 |
Regression tests require internet access, `git`, and other FreeType [build
|
106 |
-dependencies](http://git.savannah.gnu.org/cgit/freetype/freetype2.git/tree/README.git), and are
|
|
106 |
+dependencies](https://gitlab.freedesktop.org/freetype/freetype/-/blob/master/README.git), and are
|
|
107 | 107 |
time-consuming. These tests are largely meant to run on Travis CI, but can also be run locally:
|
108 | 108 |
|
109 | 109 |
```bash
|
1 | 1 |
/* Body and page */
|
2 |
-.wy-nav-content {
|
|
3 |
- max-width: 90%;
|
|
4 |
-}
|
|
5 | 2 |
.md-grid {
|
6 | 3 |
max-width: 90%;
|
7 | 4 |
}
|
8 |
-.md-sidebar--secondary {
|
|
9 |
- margin-left: 90%;
|
|
10 |
-}
|
|
11 | 5 |
p {
|
12 | 6 |
text-align: justify;
|
13 | 7 |
}
|
... | ... | @@ -4,7 +4,7 @@ |
4 | 4 |
#
|
5 | 5 |
# Convert source code markup to Markdown documentation.
|
6 | 6 |
#
|
7 |
-# Copyright (C) 2002-2020 by
|
|
7 |
+# Copyright (C) 2002-2021 by
|
|
8 | 8 |
# David Turner, Nikhil Ramakrishnan.
|
9 | 9 |
#
|
10 | 10 |
# This file is part of the FreeType project, and may only be used,
|
... | ... | @@ -3,7 +3,7 @@ |
3 | 3 |
#
|
4 | 4 |
# Check if all external modules are present.
|
5 | 5 |
#
|
6 |
-# Copyright (C) 2018-2020 by
|
|
6 |
+# Copyright (C) 2018-2021 by
|
|
7 | 7 |
# Nikhil Ramakrishnan.
|
8 | 8 |
#
|
9 | 9 |
# This file is part of the FreeType project, and may only be used,
|
... | ... | @@ -3,7 +3,7 @@ |
3 | 3 |
#
|
4 | 4 |
# Parse comment blocks to build content blocks (library file).
|
5 | 5 |
#
|
6 |
-# Copyright (C) 2002-2020 by
|
|
6 |
+# Copyright (C) 2002-2021 by
|
|
7 | 7 |
# David Turner.
|
8 | 8 |
#
|
9 | 9 |
# This file is part of the FreeType project, and may only be used,
|
... | ... | @@ -3,7 +3,7 @@ |
3 | 3 |
#
|
4 | 4 |
# Convert parsed content blocks to a structured document (library file).
|
5 | 5 |
#
|
6 |
-# Copyright (C) 2002-2020 by
|
|
6 |
+# Copyright (C) 2002-2021 by
|
|
7 | 7 |
# David Turner.
|
8 | 8 |
#
|
9 | 9 |
# This file is part of the FreeType project, and may only be used,
|
... | ... | @@ -3,7 +3,7 @@ |
3 | 3 |
#
|
4 | 4 |
# Build site configuration and write to mkdocs.yml.
|
5 | 5 |
#
|
6 |
-# Copyright (C) 2018-2020 by
|
|
6 |
+# Copyright (C) 2018-2021 by
|
|
7 | 7 |
# Nikhil Ramakrishnan.
|
8 | 8 |
#
|
9 | 9 |
# This file is part of the FreeType project, and may only be used,
|
... | ... | @@ -3,7 +3,7 @@ |
3 | 3 |
#
|
4 | 4 |
# Convert source code comments to multi-line blocks (library file).
|
5 | 5 |
#
|
6 |
-# Copyright (C) 2002-2020 by
|
|
6 |
+# Copyright (C) 2002-2021 by
|
|
7 | 7 |
# David Turner.
|
8 | 8 |
#
|
9 | 9 |
# This file is part of the FreeType project, and may only be used,
|
... | ... | @@ -3,7 +3,7 @@ |
3 | 3 |
#
|
4 | 4 |
# A sub-class container of the `Formatter' class to produce Markdown.
|
5 | 5 |
#
|
6 |
-# Copyright (C) 2018-2020 by
|
|
6 |
+# Copyright (C) 2018-2021 by
|
|
7 | 7 |
# Nikhil Ramakrishnan.
|
8 | 8 |
#
|
9 | 9 |
# This file is part of the FreeType project, and may only be used,
|
... | ... | @@ -3,7 +3,7 @@ |
3 | 3 |
#
|
4 | 4 |
# Auxiliary functions for the `docmaker' tool (library file).
|
5 | 5 |
#
|
6 |
-# Copyright (C) 2002-2020 by
|
|
6 |
+# Copyright (C) 2002-2021 by
|
|
7 | 7 |
# David Turner.
|
8 | 8 |
#
|
9 | 9 |
# This file is part of the FreeType project, and may only be used,
|
... | ... | @@ -3,7 +3,7 @@ |
3 | 3 |
#
|
4 | 4 |
# List of dependencies for the package.
|
5 | 5 |
#
|
6 |
-# Copyright (C) 2018-2020 by
|
|
6 |
+# Copyright (C) 2018-2021 by
|
|
7 | 7 |
# Nikhil Ramakrishnan.
|
8 | 8 |
#
|
9 | 9 |
# This file is part of the FreeType project, and may only be used,
|
... | ... | @@ -14,6 +14,6 @@ |
14 | 14 |
|
15 | 15 |
# Direct project dependencies
|
16 | 16 |
mistune==0.8.4
|
17 |
-mkdocs==1.1
|
|
18 |
-mkdocs-material==4.6.3
|
|
19 |
-PyYAML==5.3.1
|
|
17 |
+mkdocs==1.1.2
|
|
18 |
+mkdocs-material==7.0.6
|
|
19 |
+PyYAML==5.4.1
|
... | ... | @@ -3,7 +3,7 @@ |
3 | 3 |
#
|
4 | 4 |
# Package setup rules for docwriter.
|
5 | 5 |
#
|
6 |
-# Copyright (C) 2018-2020 by
|
|
6 |
+# Copyright (C) 2018-2021 by
|
|
7 | 7 |
# Nikhil Ramakrishnan.
|
8 | 8 |
#
|
9 | 9 |
# This file is part of the FreeType project, and may only be used,
|
... | ... | @@ -42,7 +42,7 @@ setup( |
42 | 42 |
install_requires = install_requires,
|
43 | 43 |
python_requires='>=3.5',
|
44 | 44 |
classifiers=[
|
45 |
- 'Development Status :: 4 - Beta',
|
|
45 |
+ 'Development Status :: 5 - Production/Stable',
|
|
46 | 46 |
'Environment :: Console',
|
47 | 47 |
'Intended Audience :: Developers',
|
48 | 48 |
'Operating System :: OS Independent',
|
... | ... | @@ -4,7 +4,7 @@ |
4 | 4 |
*
|
5 | 5 |
* Test header file for docwriter.
|
6 | 6 |
*
|
7 |
- * Copyright (C) 2018-2020 by
|
|
7 |
+ * Copyright (C) 2018-2021 by
|
|
8 | 8 |
* David Turner, Robert Wilhelm, and Werner Lemberg.
|
9 | 9 |
*
|
10 | 10 |
* This file is part of the FreeType project, and may only be used,
|
... | ... | @@ -6,7 +6,7 @@ set -exo pipefail |
6 | 6 |
#
|
7 | 7 |
# Clone freetype2 and make targets `refdoc' and `refdoc-venv`.
|
8 | 8 |
#
|
9 |
-# Copyright (C) 2020 by
|
|
9 |
+# Copyright (C) 2020-2021 by
|
|
10 | 10 |
# Nikhil Ramakrishnan.
|
11 | 11 |
#
|
12 | 12 |
# This file is part of the FreeType project, and may only be used,
|
... | ... | @@ -41,8 +41,8 @@ build_dir="freetype2.compile" |
41 | 41 |
|
42 | 42 |
cd "$output_dir" # go to `tests/output'
|
43 | 43 |
|
44 |
-# Clone the latest version of FreeType
|
|
45 |
-git clone https://git.savannah.gnu.org/git/freetype/freetype2.git $freetype_dir
|
|
44 |
+# Clone FreeType from master
|
|
45 |
+git clone --depth=50 --branch=master https://gitlab.freedesktop.org/freetype/freetype.git $freetype_dir
|
|
46 | 46 |
|
47 | 47 |
cd "$freetype_dir"
|
48 | 48 |
|
... | ... | @@ -3,7 +3,7 @@ |
3 | 3 |
#
|
4 | 4 |
# Integration test for docwriter.
|
5 | 5 |
#
|
6 |
-# Copyright (C) 2018-2020 by
|
|
6 |
+# Copyright (C) 2018-2021 by
|
|
7 | 7 |
# Nikhil Ramakrishnan.
|
8 | 8 |
#
|
9 | 9 |
# This file is part of the FreeType project, and may only be used,
|
... | ... | @@ -3,7 +3,7 @@ |
3 | 3 |
#
|
4 | 4 |
# Tests for docwriter parsing (sources.py and content.py).
|
5 | 5 |
#
|
6 |
-# Copyright (C) 2018-2020 by
|
|
6 |
+# Copyright (C) 2018-2021 by
|
|
7 | 7 |
# Nikhil Ramakrishnan.
|
8 | 8 |
#
|
9 | 9 |
# This file is part of the FreeType project, and may only be used,
|
... | ... | @@ -3,7 +3,7 @@ |
3 | 3 |
#
|
4 | 4 |
# Tests for site config generation (siteconfig.py).
|
5 | 5 |
#
|
6 |
-# Copyright (C) 2018-2020 by
|
|
6 |
+# Copyright (C) 2018-2021 by
|
|
7 | 7 |
# Nikhil Ramakrishnan.
|
8 | 8 |
#
|
9 | 9 |
# This file is part of the FreeType project, and may only be used,
|
... | ... | @@ -3,7 +3,7 @@ |
3 | 3 |
#
|
4 | 4 |
# Tests for markdown formatter (tomarkdown.py).
|
5 | 5 |
#
|
6 |
-# Copyright (C) 2018-2020 by
|
|
6 |
+# Copyright (C) 2018-2021 by
|
|
7 | 7 |
# Nikhil Ramakrishnan.
|
8 | 8 |
#
|
9 | 9 |
# This file is part of the FreeType project, and may only be used,
|
... | ... | @@ -3,7 +3,7 @@ |
3 | 3 |
#
|
4 | 4 |
# Tests for utility functions (utils.py).
|
5 | 5 |
#
|
6 |
-# Copyright (C) 2018-2020 by
|
|
6 |
+# Copyright (C) 2018-2021 by
|
|
7 | 7 |
# Nikhil Ramakrishnan.
|
8 | 8 |
#
|
9 | 9 |
# This file is part of the FreeType project, and may only be used,
|
... | ... | @@ -2,7 +2,7 @@ eval '(exit $?0)' && eval 'exec perl -wS -i "$0" ${1+"$@"}' |
2 | 2 |
& eval 'exec perl -wS -i "$0" $argv:q'
|
3 | 3 |
if 0;
|
4 | 4 |
|
5 |
-# Copyright (C) 2015-2020 by
|
|
5 |
+# Copyright (C) 2015-2021 by
|
|
6 | 6 |
# Werner Lemberg.
|
7 | 7 |
#
|
8 | 8 |
# This file is part of the FreeType project, and may only be used, modified,
|
1 | 1 |
[tox]
|
2 | 2 |
envlist =
|
3 |
- py35, py36, py37, py38
|
|
3 |
+ py36, py37, py38, py39
|
|
4 | 4 |
|
5 | 5 |
[testenv]
|
6 | 6 |
deps =
|