Comments (2)
ethan-kusters
commented on June 22, 2024
2
This would be a great first issue! To support this we would need to add support for parsing a new flag and then change the boolean we're passing here: https://github.com/apple/swift-docc-plugin/blob/main/Plugins/SharedPackagePluginExtensions/Target%2BdefaultSymbolGraphOptions.swift#L29
Here's an example of a custom flag the plugin currently supports: https://github.com/apple/swift-docc-plugin/blob/main/Sources/SwiftDocCPluginUtilities/PluginFlags/DisableIndexFlag.swift#L14.
Happy to help with any questions if anyone would like to take this on!
from swift-docc-plugin.
natikgadzhi
commented on June 22, 2024
Was looking around for good small issues to get myself up to speed — looks like this one is complete in #28, @sofiaromorales 👏🏼
@ethan-kusters, time to close this one? I would be happy to explore other issues and help out if I can, if you have anything that needs attention!
from swift-docc-plugin.
Related Issues (20)
- Xcode 13 produces error `Cannot find type 'SnippetBuilder' in scope`
- Cannot Specify Platform For Documents Generation HOT 1
- Ability to generate Objective-C docs for Swift symbols
- swift-docc-plugin generate-documentation results in empty docc catalog - no symbols - when using a local binary target/XCFramework
- inconsistent recognition of the target provided to `preview-documentation`
- No symbols are extracted when generating documentation (w/ the CLI) while the package uses a local XCFramework reference HOT 1
- Generated documentation could not be viewed on GitHub pages saying "The page you’re looking for can’t be found" HOT 1
- Add support for ObjC/C Package HOT 2
- Preview Documentation reports error on exit HOT 1
- Rebuild docs when snippet changes. HOT 3
- New `--include-extended-types` changes seems to break `--additional-symbol-graph-dir` HOT 4
- Failure to produce offline documentation if you consume C++ libraries via Swift C++/Interop HOT 2
- error: no such module 'UIKit' HOT 4
- Warning when building a package using the plugin with Swift 5.9.
- GitHub hosted pages fail to load function pages HOT 2
- Making this a plugin dependency for a project slows down builds and CI for many people who don't need to generate docs.
- generated docs only report: "An unknown error occurred." HOT 5
- error: Plugin does not have access to a tool named ‘docc’
- Text("Hoge", bundle: .module) fails to output static site
- req: dead link checking command for plugin
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from swift-docc-plugin.