Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/compas-dev/compas-actions.docs

https://github.com/compas-dev/compas-actions.docs

Science Score: 23.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 2 committers (50.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (10.8%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: compas-dev
  • Default Branch: main
  • Size: 15.6 KB
Statistics
  • Stars: 1
  • Watchers: 5
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 5 years ago · Last pushed almost 2 years ago
Metadata Files
Readme

README.md

compas-actions.docs

Introduction

The compas-actions.docs GitHub action is designed for building documentation for COMPAS or its plugins. It facilitates documentation generation, including handling various dependencies and publishing the docs.

Usage

To use this action in your workflow, add it to your .yml file with the necessary inputs. It's a composite action that includes multiple steps like installing dependencies, setting up a virtual display, and deploying documentation.

yaml steps: - uses: your-repo/compas-actions.docs@v3 with: doc_url: <URL of your docs site> github_token: ${{ secrets.GITHUB_TOKEN }} # Other optional inputs

Inputs

  1. doc_url: URL of the docs site. (required)
  2. github_token: GitHub token for publishing docs. (required)
  3. test_docs: Whether to test docstrings in this action. (default: 'true')
  4. python: Python version to build docs with. (default: "3.10")
  5. use_conda: Whether to build docs with conda. (default: "false")
  6. use_virtual_display: Use virtual display on Linux when matplotlib is imported. (default: "false")
  7. use_latex: Install dependencies for LaTex. (default: "false")

Outputs

  1. commit_type: Type of the commit - main, pull, or tag.
  2. current_version: Version number if the commit is a tag.
  3. subfolder: Subfolder name where the docs are built.

Examples

Here's an example of integrating compas-actions.docs into a GitHub workflow:

```yaml name: docs

on: push: branches: - main tags: - 'v*' pull_request: branches: - main

jobs: docs: runs-on: ubuntu-latest steps: - uses: compas-dev/compas-actions.docs@v3 with: githubtoken: ${{ secrets.GITHUBTOKEN }} doc_url: https://compas.dev/compas ```

If your plugin involves C++ extensions and can only be built in certain OS, you can use the use_conda input to build the docs with conda on that specific system. Here's an example:

```yaml name: docs

on: push: branches: - main tags: - 'v*' pull_request: branches: - main

jobs: docs: runs-on: windows-latest steps: - uses: compas-dev/compas-actions.docs@v3 with: githubtoken: ${{ secrets.GITHUBTOKEN }} useconda: true docurl: https://compas.dev/compas_cgal ```

Owner

  • Name: compas-dev
  • Login: compas-dev
  • Kind: organization

COMPAS - an open source computational framework for research and collaboration in AEC

GitHub Events

Total
Last Year

Committers

Last synced: 12 months ago

All Time
  • Total Commits: 42
  • Total Committers: 2
  • Avg Commits per committer: 21.0
  • Development Distribution Score (DDS): 0.048
Past Year
  • Commits: 1
  • Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Licini l****0@g****m 40
Gonzalo Casas c****s@a****h 2
Committer Domains (Top 20 + Academic)
arch.ethz.ch: 1

Issues and Pull Requests

Last synced: 12 months ago

All Time
  • Total issues: 0
  • Total pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 1.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • gonzalocasas (2)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 18
  • Total versions: 24
github actions: compas-dev/compas-actions.docs

Build docs for COMPAS or its plugins

  • Status: removed
  • Latest release: v4.0.1
    published almost 2 years ago
  • Versions: 24
  • Dependent Packages: 0
  • Dependent Repositories: 18
Rankings
Dependent packages count: 0.0%
Dependent repos count: 9.7%
Average: 23.3%
Forks count: 35.1%
Stargazers count: 48.3%
Last synced: about 1 year ago

Dependencies

action.yml actions
  • actions/checkout v3 composite
  • compas-dev/compas-actions.build v2 composite
  • compas-dev/compas-actions.docversions v2 composite
  • crazy-max/ghaction-github-pages v2 composite