Skip to content

Commit

Permalink
Remove version in generated documentation
Browse files Browse the repository at this point in the history
Ref. eng/recordflux/RecordFlux#1836
  • Loading branch information
treiher committed Dec 18, 2024
1 parent 3fb7aa8 commit 857ac27
Show file tree
Hide file tree
Showing 15 changed files with 19 additions and 23 deletions.
8 changes: 3 additions & 5 deletions doc/language_reference/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@

from sphinx.highlighting import lexers

from rflx import __version__
from tools.rflxlexer import RFLXLexer

lexers["rflx"] = RFLXLexer(startinline=True)
Expand All @@ -25,10 +24,9 @@
copyright = f"2023-{datetime.now().year}, AdaCore" # noqa: A001, DTZ005
author = "AdaCore"

# Ignore development versions in document creation
recordflux_version = __version__.split(".dev")[0]
version = recordflux_version
release = recordflux_version
# Omit version to prevent conflicts caused by dynamic versioning
version = " "
release = " "

# -- General configuration ---------------------------------------------------

Expand Down
8 changes: 3 additions & 5 deletions doc/user_guide/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@

from sphinx.highlighting import lexers

from rflx import __version__
from tools.rflxlexer import RFLXLexer

lexers["rflx"] = RFLXLexer(startinline=True)
Expand All @@ -25,10 +24,9 @@
copyright = f"2023-{datetime.now().year}, AdaCore" # noqa: A001, DTZ005
author = "AdaCore"

# Ignore development versions in document creation
recordflux_version = __version__.split(".dev")[0]
version = recordflux_version
release = recordflux_version
# Omit version to prevent conflicts caused by dynamic versioning
version = " "
release = " "

# -- General configuration ---------------------------------------------------

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0.25.1',
VERSION: ' ',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
2 changes: 1 addition & 1 deletion rflx/doc/language_reference/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
<img src="_static/adacore-logo-white.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.25.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion rflx/doc/language_reference/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<img src="_static/adacore-logo-white.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.25.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion rflx/doc/language_reference/language_reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<img src="_static/adacore-logo-white.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.25.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion rflx/doc/language_reference/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<img src="_static/adacore-logo-white.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.25.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="#" method="get">
Expand Down
2 changes: 1 addition & 1 deletion rflx/doc/user_guide/10-introduction.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<img src="_static/adacore-logo-white.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.25.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion rflx/doc/user_guide/20-overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<img src="_static/adacore-logo-white.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.25.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion rflx/doc/user_guide/90-appendix.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<img src="_static/adacore-logo-white.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.25.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion rflx/doc/user_guide/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0.25.1',
VERSION: ' ',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
2 changes: 1 addition & 1 deletion rflx/doc/user_guide/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
<img src="_static/adacore-logo-white.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.25.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion rflx/doc/user_guide/gfdl.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<img src="_static/adacore-logo-white.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.25.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion rflx/doc/user_guide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<img src="_static/adacore-logo-white.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.25.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion rflx/doc/user_guide/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<img src="_static/adacore-logo-white.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.25.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="#" method="get">
Expand Down

0 comments on commit 857ac27

Please sign in to comment.