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.

Sign up for GitHub

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

Jump to bottom

clean up docs (config, css) #615

Merged
merged 4 commits into from
May 9, 2022
Merged

clean up docs (config, css) #615

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
10fd6c8
update codeblock css hex [#614]
May 6, 2022
8c2681f
remove config/schemas page and generation [#613]
May 6, 2022
20183f5
remove unused import
May 6, 2022
160cab2
update changelog
May 6, 2022
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ The types of changes are:

* Updated `Release Steps`
* Replaced all references to `make` with `nox` [#547](https://github.com/ethyca/fides/pull/547)
* Removed config/schemas page [#613](https://github.com/ethyca/fides/issues/613)

### Fixed

Expand Down
2 changes: 1 addition & 1 deletion docs/fides/docs/css/fides.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ li code {

.highlight .filename > code{
background-color: transparent;
color: #2A2F45 ;
color: var(--md-typeset-color);
}

/*** API Page Dark Mode Compatibility ***/
Expand Down
4 changes: 0 additions & 4 deletions docs/fides/docs/schemas/config.md
View file
Open in desktop

This file was deleted.

2 changes: 0 additions & 2 deletions docs/fides/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,6 @@ nav:
- Code of Conduct: community/code_of_conduct.md
- About Ethyca: ethyca.md
- License: license.md
- Schemas:
- schemas/config.md

# Theme
theme:
Expand Down
17 changes: 1 addition & 16 deletions generate_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@
import sys

from fidesapi.main import app
from fidesctl.core.config import get_config


def generate_openapi(outfile_dir: str) -> None:
"Write out an openapi.json file for the API."
Expand All @@ -19,19 +17,6 @@ def generate_openapi(outfile_dir: str) -> None:
print(f"Exported OpenAPI JSON from fidesapi to '{outfile_path}'")


def generate_config_docs(outfile_dir: str) -> None:
"Write out a json schema for the fidesctl config."

outfile_name = "schemas/config_schema.json"
outfile_path = f"{outfile_dir}/{outfile_name}"
print(f"Generating Config JSON Schema and writing to '{outfile_path}'...")
with open(outfile_path, "w") as outfile:
config_schema = get_config().schema_json(indent=2)
outfile.write(config_schema)
print(f"Exported Config JSON Schema '{outfile_path}'")


if __name__ == "__main__":
outfile_dir = sys.argv[1]
generate_openapi(outfile_dir)
generate_config_docs(outfile_dir)
generate_openapi(outfile_dir)