Skip to content

Commit

Permalink
Merge pull request #105 from mole99/docs-fix
Browse files Browse the repository at this point in the history
Do not add broken links to the documentation
  • Loading branch information
mole99 authored Aug 21, 2024
2 parents 1ede40d + ae254b7 commit 021bb94
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 9 deletions.
6 changes: 6 additions & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# 2.4.10

## Common

- Fix: Do not include broken links in the documentation if no layout is available

# 2.4.9

## Common
Expand Down
2 changes: 1 addition & 1 deletion cace/__version__.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
__version__ = '2.4.9'
__version__ = '2.4.10'

if __name__ == '__main__':
print(__version__, end='')
18 changes: 10 additions & 8 deletions cace/common/cace_write.py
Original file line number Diff line number Diff line change
Expand Up @@ -157,14 +157,16 @@ def generate_documentation(datasheet):
f'![Schematic of {datasheet["name"]}]({datasheet["name"]}_schematic.svg)\n'
)

# Add layout images
ofile.write(f'\n## Layout\n\n')
ofile.write(
f'![Layout of {datasheet["name"]} with white background]({datasheet["name"]}_w.png)\n'
)
ofile.write(
f'![Layout of {datasheet["name"]} with black background]({datasheet["name"]}_b.png)\n'
)
if 'layout' in datasheet['paths']:

# Add layout images
ofile.write(f'\n## Layout\n\n')
ofile.write(
f'![Layout of {datasheet["name"]} with white background]({datasheet["name"]}_w.png)\n'
)
ofile.write(
f'![Layout of {datasheet["name"]} with black background]({datasheet["name"]}_b.png)\n'
)

# Generate xschem symbol svg
svgpath = os.path.join(
Expand Down

0 comments on commit 021bb94

Please sign in to comment.