Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ active_links.txt
active_links.json

# Files used by scripts to autogenerate settings and do spellcheck
scripts/settings/tmp
scripts/autogenerated-docs/tmp

# Files whose content gets autogenerated
docs/cloud/manage/api/invitations-api-reference.md
Expand Down
20 changes: 10 additions & 10 deletions contribute/autogenerated-documentation-from-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ into the appropriate pages before build time of the docs.
## Session settings

Documentation for session settings is autogenerated from source file [`src/Core/Settings.cpp`](https://github.com/ClickHouse/ClickHouse/blob/master/src/Core/Settings.cpp).
[SQL](../scripts/settings/session-settings.sql)
[SQL](../scripts/autogenerated-docs/session-settings.sql)

## Format settings

Documentation for session settings is autogenerated from source file [`src/Core/FormatFactorySettings.h`](https://github.com/ClickHouse/ClickHouse/blob/master/src/Core/FormatFactorySettings.h).
[SQL](../scripts/settings/format-settings.sql)
[SQL](../scripts/autogenerated-docs/format-settings.sql)

## Server settings

Expand Down Expand Up @@ -46,13 +46,13 @@ If it is, then please edit the setting description in the source code documentat
in [`ServerSettings.cpp`](https://github.com/ClickHouse/ClickHouse/blob/master/src/Core/ServerSettings.cpp)
or else edit `_server_settings_outside_source.md`.**

[SQL](../scripts/settings/global-server-settings.sql)
[SQL](../scripts/autogenerated-docs/global-server-settings.sql)

## MergeTree settings

Documentation for MergeTree settings is autogenerated from [MergeTreeSettings.cpp](https://github.com/ClickHouse/ClickHouse/blob/master/src/Storages/MergeTree/MergeTreeSettings.cpp)

[SQL](../scripts/settings/mergetree-settings.sql)
[SQL](../scripts/autogenerated-docs/mergetree-settings.sql)

## System tables

Expand All @@ -69,10 +69,10 @@ To add a new page:
copy to which file in between the `<!--AUTOGENERATED_START-->` and `<!--AUTOGENERATED_END-->`

The following pages are autogenerated from the source code for functions:
- [Arithmetic](/sql-reference/functions/arithmetic-functions) ([SQL](../scripts/settings/arithmetic-functions.sql))
- [Arrays](/sql-reference/functions/array-functions) ([SQL](../scripts/settings/array-functions.sql))
- [Bit](/sql-reference/functions/bit-functions) ([SQL](../scripts/settings/bit-functions.sql))
- [Bitmap](/sql-reference/functions/bitmap-functions) ([SQL](../scripts/settings/bitmap-functions.sql))
- [Comparison](/sql-reference/functions/comparison-functions) ([SQL](../scripts/settings/comparison-functions.sql))
- [Conditional](/sql-reference/functions/conditional-functions) ([SQL](../scripts/settings/conditional-functions.sql))
- [Arithmetic](/sql-reference/functions/arithmetic-functions) ([SQL](../scripts/autogenerated-docs/arithmetic-functions.sql))
- [Arrays](/sql-reference/functions/array-functions) ([SQL](../scripts/autogenerated-docs/array-functions.sql))
- [Bit](/sql-reference/functions/bit-functions) ([SQL](../scripts/autogenerated-docs/bit-functions.sql))
- [Bitmap](/sql-reference/functions/bitmap-functions) ([SQL](../scripts/autogenerated-docs/bitmap-functions.sql))
- [Comparison](/sql-reference/functions/comparison-functions) ([SQL](../scripts/autogenerated-docs/comparison-functions.sql))
- [Conditional](/sql-reference/functions/conditional-functions) ([SQL](../scripts/autogenerated-docs/conditional-functions.sql))

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"private": true,
"config": {
"clickhouse_repo_folders": "docs/en/development docs/en/engines docs/en/interfaces docs/en/operations docs/en/sql-reference",
"autogen_needed_files": "src/Core/FormatFactorySettings.h src/Core/Settings.cpp CHANGELOG.md docs/en/operations/server-configuration-parameters/_server_settings_outside_source.md"
"autogen_needed_files": "CHANGELOG.md docs/en/operations/server-configuration-parameters/_server_settings_outside_source.md"
},
"scripts": {
"build": "yarn copy-clickhouse-repo-docs && yarn check-markdown && yarn generate-changelog && yarn autogenerate-settings && yarn autogenerate-table-of-contents && yarn build-swagger && scripts/sed_links.sh && yarn build-docs",
Expand All @@ -15,7 +15,7 @@
"serve": "docusaurus serve",
"build-swagger": "yarn redocly build-docs https://api.clickhouse.cloud/v1 --output build/cloud/manage/api/swagger.html",
"prep-from-local": "bash ./scripts/copy-clickhouse-repo-docs.sh -l $1",
"autogenerate-settings": "bash ./scripts/settings/autogenerate-settings.sh",
"autogenerate-settings": "bash scripts/autogenerated-docs/autogenerate-settings.sh",
"autogenerate-table-of-contents": "bash ./scripts/autogenerate-table-of-contents.sh",
"generate-changelog": "bash ./scripts/generate-changelog.sh",
"build-docs": "bash ./scripts/build.sh",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
WITH
'FormatFactorySettings.h' AS cpp_file,
settings_from_cpp AS
(
SELECT extract(line, 'DECLARE\\(\\w+, (\\w+),') AS name
FROM file(cpp_file, LineAsString)
WHERE match(line, '^\\s*DECLARE\\(')
),
main_content AS
(
SELECT format('## {} {} {} \n\n{}\n\n{}\n\n',
Expand All @@ -14,7 +7,8 @@ WITH
multiIf(tier == 'Experimental', '<ExperimentalBadge/>', tier == 'Beta', '<BetaBadge/>', ''),
if(type != '' AND default != '', format('<SettingsInfoBlock type="{}" default_value="{}" />', type, default), ''),
trim(BOTH '\\n' FROM description))
FROM system.settings WHERE name IN settings_from_cpp
FROM system.settings
WHERE type = 'format_setting' AND is_obsolete = 0
ORDER BY name
),
'' ||
Expand All @@ -33,7 +27,7 @@ import SettingsInfoBlock from ''@theme/SettingsInfoBlock/SettingsInfoBlock'';
import VersionHistory from ''@theme/VersionHistory/VersionHistory'';

<!-- Autogenerated -->
These settings are autogenerated from [source](https://github.com/ClickHouse/ClickHouse/blob/master/src/Core/FormatFactorySettings.h).
These settings are autogenerated from system tables.

' AS prefix
SELECT prefix || (SELECT groupConcat(*) FROM main_content)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
WITH
'Settings.cpp' AS cpp_file,
settings_changes AS
(
SELECT
Expand Down Expand Up @@ -34,12 +33,6 @@ WITH
)
GROUP BY setting_name
),
settings_from_cpp AS
(
SELECT extract(line, 'DECLARE(?:_WITH_ALIAS)?\\(\\w+, (\\w+),') AS name
FROM file(cpp_file, LineAsString)
WHERE match(line, '^\\s*DECLARE(?:_WITH_ALIAS)?\\(')
),
settings_with_change_history AS
(
SELECT
Expand All @@ -49,7 +42,7 @@ WITH
system.settings AS a
LEFT OUTER JOIN settings_changes as b
ON a.name = b.name
WHERE name IN settings_from_cpp
WHERE a.is_obsolete = 0
),
main_content AS
(
Expand Down Expand Up @@ -89,7 +82,7 @@ import SettingsInfoBlock from \'@theme/SettingsInfoBlock/SettingsInfoBlock\';
import VersionHistory from \'@theme/VersionHistory/VersionHistory\';

<!-- Autogenerated -->
All below settings are also available in table [system.settings](/docs/operations/system-tables/settings). These settings are autogenerated from [source](https://github.com/ClickHouse/ClickHouse/blob/master/src/Core/Settings.cpp).
All below settings are also available in table [system.settings](/docs/operations/system-tables/settings). These settings are autogenerated from system tables.

' AS prefix
SELECT prefix || (SELECT groupConcat(*) FROM main_content)
Expand Down
Loading