Skip to content

Commit 0cc3118

Browse files
committed
website: Make latest release (1.7) be default manual
Move deveopment manual.yml to dev/manual.yml Symlink manual.yml to v1.7/manual.yml Refactor to share history header with links to other manual versions. Change man.test and man page generation to use dev/manual.yml Related to #3078 #3127
1 parent 7cd23f1 commit 0cc3118

File tree

12 files changed

+3818
-3840
lines changed

12 files changed

+3818
-3840
lines changed

Makefile.am

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -160,10 +160,10 @@ check_DATA = tests/man.test
160160
# Making changes to the manpage without having the python deps means your
161161
# tests won't run. If you aren't making changes to the examples, you probably
162162
# don't care. But if you are, then you need to run the tests anyway.
163-
tests/man.test tests/manonig.test: $(srcdir)/docs/content/manual/manual.yml
163+
tests/man.test tests/manonig.test: $(srcdir)/docs/content/manual/dev/manual.yml
164164
if ENABLE_DOCS
165165
$(AM_V_GEN) ( cd ${abs_srcdir}/docs && \
166-
$(PIPENV) run python validate_manual_schema.py content/manual/manual.yml && \
166+
$(PIPENV) run python validate_manual_schema.py content/manual/dev/manual.yml && \
167167
$(PIPENV) run python build_mantests.py )
168168
else
169169
@echo Changes to the manual.yml require docs to be enabled to update the manual test.
@@ -176,10 +176,10 @@ endif
176176
# manpage, then we'll end up using the cached version. Otherwise, we need to
177177
# rebuild it.
178178
man_MANS = jq.1
179-
jq.1.prebuilt: $(srcdir)/docs/content/manual/manual.yml
179+
jq.1.prebuilt: $(srcdir)/docs/content/manual/dev/manual.yml
180180
if ENABLE_DOCS
181181
$(AM_V_GEN) ( cd ${abs_srcdir}/docs && \
182-
$(PIPENV) run python validate_manual_schema.py content/manual/manual.yml && \
182+
$(PIPENV) run python validate_manual_schema.py content/manual/dev/manual.yml && \
183183
$(PIPENV) run python build_manpage.py ) > $@
184184
else
185185
@echo Changes to the manual.yml require docs to be enabled to update the manpage.

docs/build_manpage.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ def dedent_body(body):
209209

210210
def convert_manual_to_markdown():
211211
f = StringIO()
212-
manual = load_yml_file("content/manual/manual.yml")
212+
manual = load_yml_file("content/manual/dev/manual.yml")
213213
f.write(manual.get('manpage_intro', '\n'))
214214
f.write(dedent_body(manual.get('body', '\n')))
215215
for section in manual.get('sections', []):

docs/build_mantests.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
regex_program_pattern = re.compile(
66
r'\b(?:test|match|capture|scan|split|splits|sub|gsub)\s*\(')
77

8-
with open('content/manual/manual.yml') as source, \
8+
with open('content/manual/dev/manual.yml') as source, \
99
open('../tests/man.test', 'w') as man, \
1010
open('../tests/manonig.test', 'w') as manonig:
1111
manual = yaml.safe_load(source)

0 commit comments

Comments
 (0)