GithubHelp home page GithubHelp logo

futureworkshops / bitrise-step-create-apple-documentation Goto Github PK

View Code? Open in Web Editor NEW
0.0 0.0 1.0 45 KB

Step used to export an HTML and docset for an iOS/macOS Framework documentation

License: MIT License

Shell 48.16% Objective-C 37.30% Swift 14.54%
bitrise

bitrise-step-create-apple-documentation's People

Contributors

andrewmarmion avatar igorcferreira avatar

Watchers

 avatar  avatar  avatar

Forkers

andrewmarmion

bitrise-step-create-apple-documentation's Issues

Integration with Bitrise

Hello there!

I'm currently trying to integrate Jazzy on Bitrise, I found you're step, and I'm guessing it does the job of running Jazzy to deliver the Docs.

So I've implemented it after pulling the code from the repository. But when it comes the time to run your step, it returns the following error:
[email protected] (exit code: 1)

Here's the configuration:
Configs:

  • project_path: ./
  • language: swift
  • author: Unknown
  • sdk: iphone
  • version: 1.0.0
  • framework_root: ./
  • module: First_Test
  • acl: public
  • output: ./docs
  • readme: ../README.md
  • title: Unknown Documentation
  • copyright:
  • umbrella_header:

Am I doing something wrong? One note is that my project has a white space on its name, so its like: "First Test".

Can you give me some help?

Thanks!
António Ferreira.

Problem when building this step

Hello Igor,

Sorry to disturb you again, but even with the updated step, it keeps getting an error.

Configs:

  • jazzy_configuration:
  • project_path: "/Users/vagrant/git/Project Title"
  • language: swift
  • author: Project Title
  • sdk: iphone
  • version: 1.0.0
  • framework_root: "/Users/vagrant/git/Project Title"
  • module: Project Title (Development)
  • scheme: Project Title (Development)
  • acl: public
  • output: ./docs
  • readme: ./README.md
  • title: Project Title
  • copyright:
  • umbrella_header:

I'm using the latest stack, could you also give more information when the build fails?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.