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

Namnn/need per id json #960

Merged
merged 91 commits into from
Sep 6, 2023
Merged
Changes from 1 commit
Commits
Show all changes
91 commits
Select commit Hold shift + click to select a range
eb546d4
gen needs.json per needs.id and command some service git to bypass test
nhatnamnguyengtvthcm Jul 7, 2023
600ad3f
update review 11/07
nhatnamnguyengtvthcm Jul 12, 2023
0228b24
update review 11/07
nhatnamnguyengtvthcm Jul 12, 2023
9a698b0
update conf
nhatnamnguyengtvthcm Jul 14, 2023
3de0647
config variable for needs_id forder path
nhatnamnguyengtvthcm Jul 19, 2023
dbb52c0
update env config for needs per id
nhatnamnguyengtvthcm Jul 21, 2023
01320d4
add configuration for needs per id~
nhatnamnguyengtvthcm Jul 21, 2023
177d3e3
add configuration for needs per id~
nhatnamnguyengtvthcm Jul 21, 2023
efbe1fa
fix-ci-lint-err
nhatnamnguyengtvthcm Aug 4, 2023
04f5019
fix-ci-lint-err
nhatnamnguyengtvthcm Aug 4, 2023
be61481
fix-ci-lint-err
nhatnamnguyengtvthcm Aug 4, 2023
103cc2f
fix-ci-lint-err
nhatnamnguyengtvthcm Aug 4, 2023
274842f
fix-ci-lint-err
nhatnamnguyengtvthcm Aug 4, 2023
1c2af5b
fix-ci-lint-err
nhatnamnguyengtvthcm Aug 4, 2023
9136af8
add test-case and fix some setting for need per id builder
nhatnamnguyengtvthcm Aug 7, 2023
26a18b8
add test-case and fix some setting for need per id builder
nhatnamnguyengtvthcm Aug 7, 2023
ac7c5fe
add test-case and fix some setting for need per id builder
nhatnamnguyengtvthcm Aug 7, 2023
618e1b0
add test-case and fix some setting for need per id builder
nhatnamnguyengtvthcm Aug 7, 2023
8802a04
add test-case and fix some setting for need per id builder
nhatnamnguyengtvthcm Aug 7, 2023
55e0cd3
add test-case and fix some setting for need per id builder
nhatnamnguyengtvthcm Aug 9, 2023
6462295
add test-case and fix some setting for need per id builder
nhatnamnguyengtvthcm Aug 9, 2023
dbb9f3f
add test-case and fix some setting for need per id builder
nhatnamnguyengtvthcm Aug 9, 2023
13c1ca7
add test-case and fix some setting for need per id builder
nhatnamnguyengtvthcm Aug 9, 2023
86bcfef
add test-case and fix some setting for need per id builder
nhatnamnguyengtvthcm Aug 9, 2023
f42e9d7
add test-case and fix some setting for need per id builder
nhatnamnguyengtvthcm Aug 9, 2023
f0ec457
add test-case and fix some setting for need per id builder
nhatnamnguyengtvthcm Aug 10, 2023
724a367
change version build
nhatnamnguyengtvthcm Aug 21, 2023
7e5b7e4
change changelog file
nhatnamnguyengtvthcm Aug 21, 2023
86e343a
Removed esbonio for IDE support
haiyangToAI Feb 17, 2023
30cae4d
enable docker arm builds
cpolzer May 31, 2023
41c0368
🔧 Add .nox to gitignore
chrisjsewell Aug 2, 2023
bb83ac1
Update pyproject.toml
chrisjsewell Aug 3, 2023
c3ff8b6
Update pyproject.toml
chrisjsewell Aug 3, 2023
7ca8d6e
Update requirements.txt
chrisjsewell Aug 3, 2023
7680146
Update api.rst
chrisjsewell Aug 3, 2023
e969347
Added config allow unsafe filter for filter_func (#949)
haiyangToAI Aug 3, 2023
3935da6
🔧 Update pre-commit hooks (#956)
chrisjsewell Aug 4, 2023
e518929
Bump actions/checkout from 3.3.0 to 3.5.3
dependabot[bot] Jun 12, 2023
8a500e6
needs: Remove some of the extra IDs in the output
tim-nordell-nimbelink Nov 21, 2022
786db24
Added config option needs_report_dead_links (#937)
haiyangToAI Aug 4, 2023
624fd84
Raises version to 1.3.0
danwos Aug 16, 2023
ee77802
👌 Performance: Memoize Inline Parser
chrisjsewell Aug 11, 2023
cbc7bc0
fix linting
chrisjsewell Aug 16, 2023
ceae80e
Add to changelog
chrisjsewell Aug 16, 2023
4ee996e
Easier Sphinx-Needs docs builds
danwos Aug 18, 2023
b8fe439
Docker fix
danwos Aug 18, 2023
1b79d17
Removing docker context: ci
danwos Aug 18, 2023
ab99745
gen needs.json per needs.id and command some service git to bypass test
nhatnamnguyengtvthcm Jul 7, 2023
b9a0f99
update conf
nhatnamnguyengtvthcm Jul 14, 2023
f868ffe
update env config for needs per id
nhatnamnguyengtvthcm Jul 21, 2023
4985e9f
fix-ci-lint-err
nhatnamnguyengtvthcm Aug 4, 2023
0c8e80f
add test-case and fix some setting for need per id builder
nhatnamnguyengtvthcm Aug 7, 2023
18cbd4e
add test-case and fix some setting for need per id builder
nhatnamnguyengtvthcm Aug 9, 2023
305ad77
add test-case and fix some setting for need per id builder
nhatnamnguyengtvthcm Aug 10, 2023
d9a967d
change version build
nhatnamnguyengtvthcm Aug 21, 2023
a9edc4e
update change log
nhatnamnguyengtvthcm Aug 21, 2023
bd18a2b
change release version
nhatnamnguyengtvthcm Aug 21, 2023
6d50c27
♻️ Change `NeedsBuilder` format to `needs`
chrisjsewell Aug 21, 2023
b6819f4
Update changelog.rst
chrisjsewell Aug 21, 2023
588e4cf
gen needs.json per needs.id and command some service git to bypass test
nhatnamnguyengtvthcm Jul 7, 2023
5c30c12
update review 11/07
nhatnamnguyengtvthcm Jul 12, 2023
6fd7eba
fix-ci-lint-err
nhatnamnguyengtvthcm Aug 4, 2023
f85bb09
add test-case and fix some setting for need per id builder
nhatnamnguyengtvthcm Aug 7, 2023
d474b40
add test-case and fix some setting for need per id builder
nhatnamnguyengtvthcm Aug 9, 2023
aaf3869
add test-case and fix some setting for need per id builder
nhatnamnguyengtvthcm Aug 9, 2023
1a288e0
add test-case and fix some setting for need per id builder
nhatnamnguyengtvthcm Aug 10, 2023
d8013c9
change version build
nhatnamnguyengtvthcm Aug 21, 2023
819e716
change changelog file
nhatnamnguyengtvthcm Aug 21, 2023
7aac5d3
Raises version to 1.3.0
danwos Aug 16, 2023
41609ff
Add to changelog
chrisjsewell Aug 16, 2023
4d88520
Easier Sphinx-Needs docs builds
danwos Aug 18, 2023
6f5e62e
update conf
nhatnamnguyengtvthcm Jul 14, 2023
6ff9b71
change version build
nhatnamnguyengtvthcm Aug 21, 2023
d1c46ac
rebase and merge version 1.3.0
nhatnamnguyengtvthcm Aug 21, 2023
c2ef673
merge version 1.3.0
nhatnamnguyengtvthcm Aug 21, 2023
5e8fc85
fix merge version 1.3.0
nhatnamnguyengtvthcm Aug 21, 2023
71988c4
fix merge version 1.3.0
nhatnamnguyengtvthcm Aug 21, 2023
a0c771b
move kogic in needs id builder into needsfile
nhatnamnguyengtvthcm Aug 25, 2023
4d06008
move kogic in needs id builder into needsfile
nhatnamnguyengtvthcm Aug 25, 2023
a5af64f
move kogic in needs id builder into needsfile
nhatnamnguyengtvthcm Aug 25, 2023
9077dca
using doc_needs_builder for test needs_id builder
nhatnamnguyengtvthcm Aug 28, 2023
025cfc5
mofify configuration.rst
nhatnamnguyengtvthcm Aug 28, 2023
dafb701
merge version 1.3.0
nhatnamnguyengtvthcm Aug 28, 2023
cf47fd4
change version needs_id builder
nhatnamnguyengtvthcm Aug 28, 2023
b84e4cc
fix test case for needs_id_builder
nhatnamnguyengtvthcm Aug 28, 2023
ef926b1
update version 1.3.0
nhatnamnguyengtvthcm Aug 30, 2023
0ac8a56
update version 1.3.0
nhatnamnguyengtvthcm Aug 30, 2023
3a10072
update version 1.3.0
nhatnamnguyengtvthcm Aug 30, 2023
49e91cb
update version 1.3.0
nhatnamnguyengtvthcm Aug 30, 2023
43689e5
refactor confiuration file and builder
nhatnamnguyengtvthcm Aug 31, 2023
ba544e7
add version 1.4.0 in needs_build_json_per_id_path configurations.rst
nhatnamnguyengtvthcm Sep 6, 2023
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
Prev Previous commit
Next Next commit
add test-case and fix some setting for need per id builder
  • Loading branch information
nhatnamnguyengtvthcm committed Aug 9, 2023
commit 86bcfefc99bfebfac0e9f24730fe58fd601cba31
2 changes: 1 addition & 1 deletion docs/builders.rst
Original file line number Diff line number Diff line change
@@ -169,7 +169,7 @@ or

needs_id
--------
.. versionadded:: 0.1.30
.. versionadded:: 0.1.3.0

The **needs_id** builder exports all found needs and selected filter results to a set json files of each need with the name is ``id`` of need.
danwos marked this conversation as resolved.
Show resolved Hide resolved

danwos marked this conversation as resolved.
Show resolved Hide resolved
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -380,7 +380,7 @@ def custom_defined_func():
# build needs.json to make permalinks work
needs_build_json = True
# build needs_json for every needs-id to make detail panel
needs_build_json_per_id = True
needs_build_json_per_id = False
# Get and maybe set GitHub credentials for services.
# This is needed as the rate limit for not authenticated users is too low for the amount of requests we
# need to perform for this documentation
@@ -585,7 +585,7 @@ def custom_defined_func():
# Check, if docs get built on ci.
# If this is the case, external services like Open-Needs are not available and
# docs will show images instead of getting real data.
on_ci = os.environ.get("ON_CI", "False").upper() == "TRUE"
on_ci = os.environ.get("ON_CI", "True").upper() == "TRUE"
fast_build = os.environ.get("FAST_BUILD", "False").upper() == "TRUE"

html_context = {"on_ci": on_ci, "fast_build": fast_build}
34 changes: 18 additions & 16 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
@@ -2339,6 +2339,24 @@ Default value: True

Can be overwritten for each single need by setting :ref:`need_collapse`.

.. _needs_build_json_per_id:

needs_build_json_per_id
~~~~~~~~~~~~~~~~~~~~~~~
danwos marked this conversation as resolved.
Show resolved Hide resolved
Builds list json file for each need, which have name is ``ID`` of need.
nhatnamnguyengtvthcm marked this conversation as resolved.
Show resolved Hide resolved
This option works like :ref:`needs_build_json`.

Default: False

Example:

.. code-block:: python

needs_build_json_per_id = False

.. hint::
The created single json file per need, located in :ref:`needs_build_json_per_id_path` folder. This is e.g ``_build/needs_id/abc_432.json``
nhatnamnguyengtvthcm marked this conversation as resolved.
Show resolved Hide resolved

.. _needs_build_json_per_id_path:

needs_build_json_per_id_path
@@ -2358,21 +2376,5 @@ Example:

The created ``needs_id`` folder gets stored in the ``outdir`` of the current builder. The final location is e.g. ``_build/needs_id``

.. _needs_build_json_per_id:

needs_build_json_per_id
~~~~~~~~~~~~~~~~~~~~~~~
Builds list json file for each need, which have name is ``ID`` of need.
This option works like :ref:`needs_build_json`.

Default: False

Example:

.. code-block:: python

needs_build_json_per_id = False

.. hint::
The created single json file per need, located in :ref:`needs_build_json_per_id_path` folder. This is e.g ``_build/needs_id/abc_432.json``