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

Move docs generations to bazel distribution #393

Conversation

krishnangovindraj
Copy link
Member

@krishnangovindraj krishnangovindraj commented Dec 20, 2023

What is the goal of this PR?

Moves bazel rules used for generating documentation into the vaticle/bazel-distribution repository

What are the changes implemented in this PR?

  • Moves bazel rules & targets for converters of {doxygen, javadoc, sphinx (python), rustdocs} into bazel-distribution. Note: nodejs typedocs hasn't been migrated

PR chain: typedb/typedb-driver#552 > typedb/typedb-dependencies#491 > #393

@typedb-bot
Copy link
Member

typedb-bot commented Dec 20, 2023

PR Review Checklist

Do not edit the content of this comment. The PR reviewer should simply update this comment by ticking each review item below, as they get completed.


Trivial Change

  • This change is trivial and does not require a code or architecture review.

Code

  • Packages, classes, and methods have a single domain of responsibility.
  • Packages, classes, and methods are grouped into cohesive and consistent domain model.
  • The code is canonical and the minimum required to achieve the goal.
  • Modules, libraries, and APIs are easy to use, robust (foolproof and not errorprone), and tested.
  • Logic and naming has clear narrative that communicates the accurate intent and responsibility of each module (e.g. method, class, etc.).
  • The code is algorithmically efficient and scalable for the whole application.

Architecture

  • Any required refactoring is completed, and the architecture does not introduce technical debt incidentally.
  • Any required build and release automations are updated and/or implemented.
  • Any new components follows a consistent style with respect to the pre-existing codebase.
  • The architecture intuitively reflects the application domain, and is easy to understand.
  • The architecture has a well-defined hierarchy of encapsulated components.
  • The architecture is extensible and scalable.

</pre>


Creates HTML documentation for C++ projects using Doxygen.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs should note that Doxygen must be installed externally - this is not a hermitic rule.

@flyingsilverfin flyingsilverfin merged commit c63720a into typedb:master Jan 12, 2024
2 checks passed
flyingsilverfin pushed a commit to typedb/typedb-dependencies that referenced this pull request Jan 12, 2024
## What is the goal of this PR?
Moves docs generation rules & tools to the bazel-distribution repository

## What are the changes implemented in this PR?
* Moves doc generation rules & tools to bazel-distribution
* Bumps the dependency on bazel-distribution.

PR chain: typedb/typedb-driver#552 > #491 >
typedb/bazel-distribution#393
flyingsilverfin pushed a commit to typedb/typedb-driver that referenced this pull request Jan 12, 2024
## Usage and product changes
Moves bazel rules used for generating documentation into the
vaticle/bazel-distribution repository

## Implementation
* Updates BUILD files to reflect moving converters for {doxygen,
javadoc, sphinx (python), rustdocs} into bazel-distribution

PR chain: #552 > typedb/typedb-dependencies#491 >
typedb/bazel-distribution#393
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants