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

Fix copyright and build status in documentation #2

Merged
merged 1 commit into from
Oct 25, 2024
Merged
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
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,18 @@ They can be used individually, but are designed to be used together.

## Sphinx Documentation

- **dox_style**: Standard configuration, theme enhancements and style checks.
- **dox_util**: Convenience features for Sphinx documentations.
- **dox_trace**: Specification directives to achieve traceability.
- [dox_style](https://esrlabs.github.io/dox/dox_style):
Standard configuration, theme enhancements and style checks.
- [dox_util](https://esrlabs.github.io/dox/dox_util):
Convenience features for Sphinx documentations.
- [dox_trace](https://esrlabs.github.io/dox/dox_trace):
Specification directives to achieve traceability.

These tools are written in Python.

## Writing Requirements

- **Dim**: A light-weight requirements tool based on YAML files.
- [Dim](https://esrlabs.github.io/dox/dim):
A light-weight requirements tool based on YAML files.

This tool is written in Ruby.
5 changes: 1 addition & 4 deletions dim/documentation/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,7 @@

project = "Dim"
author = "Accenture"
copyright = (
f"{datetime.now().year} Accenture. All rights reserved. "
f"Accenture proprietary and confidential material"
)
copyright = f"{datetime.now().year} Accenture"

html_context = {"document_status_default": "Released", "data_classification_default": None}

Expand Down
4 changes: 4 additions & 0 deletions documentation/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,15 @@ help:
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" -W $(SPHINXOPTS) $(O)


dist: export OFFICIAL_BUILD := 1
dist: Makefile
@rm -rf "$(BUILDDIR)"
@ruby footer.rb
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" -W $(SPHINXOPTS) $(O)

@for tool in dox_style dox_util dox_trace dim ; do \
rm -rf ../$$tool/documentation/build ; \
ruby ../$$tool/documentation/footer.rb ; \
$(MAKE) -C ../$$tool/documentation html ; \
mkdir -p build/html/$$tool ; \
Expand Down
5 changes: 1 addition & 4 deletions documentation/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,7 @@

project = "Dox"
author = "Accenture"
copyright = (
f"{datetime.now().year} Accenture. All rights reserved. "
f"Accenture proprietary and confidential material"
)
copyright = f"{datetime.now().year} Accenture"

version = "1.0.0"

Expand Down
7 changes: 3 additions & 4 deletions dox_style/documentation/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,7 @@

project = "dox_style"
author = "Accenture"
copyright = (
f"{datetime.now().year} Accenture. All rights reserved. "
f"Accenture proprietary and confidential material"
)
copyright = f"{datetime.now().year} Accenture"

global __version__
exec(open(f"../../{project}/version.py", "r").read(), globals())
Expand All @@ -23,3 +20,5 @@
"dox_style",
"dox_util",
]

dox_style_footer = "footer.yaml"
5 changes: 1 addition & 4 deletions dox_trace/documentation/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,7 @@

project = "dox_trace"
author = "Accenture"
copyright = (
f"{datetime.now().year} Accenture. All rights reserved. "
f"Accenture proprietary and confidential material"
)
copyright = f"{datetime.now().year} Accenture"

global __version__
exec(open(f"../../{project}/version.py", "r").read(), globals())
Expand Down
5 changes: 1 addition & 4 deletions dox_util/documentation/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,7 @@

project = "dox_util"
author = "Accenture"
copyright = (
f"{datetime.now().year} Accenture. All rights reserved. "
f"Accenture proprietary and confidential material"
)
copyright = f"{datetime.now().year} Accenture"

global __version__
exec(open(f"../../{project}/version.py", "r").read(), globals())
Expand Down