Comments (20)
This feature is very important to us and to DocC but because of how central it is to the broader support for combined documentation for multiple modules, it needs to be thoroughly thought through so that there is a good path forward for future directions and so that we're not designing ourselves into a corner further down the line.
I find the thread of an individual issue to be both too broad and too narrow for the various discussions around a feature like this. The Swift Forums is a better place for that. That's where we've gathered inputs for use cases and discussed a proposed high level design for this. That design remains largely unchanged although some initial work have revealed a few areas that require further consideration to ensure that we have enough flexibility going forward without needing to design absolutely everything up front.
I should follow up in the Swift Forums with additional details about the plan.
I'll also think about ways, for example keywords, to indicate what issues and pull requests relate to multi-module documentation for those developers who want to follow along in the repo or who want to contribute.
from swift-docc.
I want to emphasize that it's very early but we are making some progress on this front with #710.
Even when that PR is merged, the overall user experience will be incomplete until we also support combining documentation from multiple targets into a unified archive.
from swift-docc.
👍 . This is the only thing preventing me from using DocC for my documentation.
from swift-docc.
This has also been filed in Feedback Assistant with FB9410972
from swift-docc.
Comment by Ellen Shapiro (JIRA)
This would also be super-helpful for us at Apollo GraphQL - we have small sub-libraries for things like handling a SQLite persistence layer and WebSockets that we would love to be able to link to our main lib as well.
from swift-docc.
Comment by Alexey Ivashko (JIRA)
+1 on this. I distribute internal frameworks as one package but as several different libraries in order to use only the code I needed for my targets. Referencing another module from my own would be such a pleasure, because I have several "protocol" only frameworks that have "concrete" frameworks implementations. And also, sometimes I would like to reference existing system framework documentation in order to guide user to fully learn about my api
from swift-docc.
Comment by Martin Heinrich (JIRA)
+1 for this request
Work is split into multiple modules and documentation needs to mention types that are referenced or extended. This is the case for modules under ones control, but even more for third party modules used or operating system frameworks.
from swift-docc.
+1 on this as well. We'd also need to cross-reference across targets in the Distributed Tracing repos.
from swift-docc.
Comment by Akos Polster (JIRA)
+1 on this. We are distributing an SDK as a set of frameworks. Documenting them as a single unit would be great.
from swift-docc.
any news for this ?
from swift-docc.
I would also be very much interested in having this support implemented.
from swift-docc.
+1 for this feature. Sometimes it is incredible usable
from swift-docc.
+1 for this feature!
from swift-docc.
+1 for this feature, it's very important to me!
from swift-docc.
Big +1 gang.
from swift-docc.
+2 if allowed, otherwise +1. Been looking for a way to do this for quite some time
from swift-docc.
+1 for this feature
from swift-docc.
+1 for this guyssss
from swift-docc.
Any news regarding implementation?
from swift-docc.
+1 for this feature
from swift-docc.
Related Issues (20)
- Index for Single-Article only archive is not generated correctly
- Can't reference forward-slash operator functions HOT 6
- Typealiased type are not reflected properly in the documentation HOT 4
- Reenable DefaultDiagnosticConsoleFormatter HOT 1
- Crash when building locally HOT 4
- Duplicated diagnostic causing crash on DefaultDiagnosticConsoleFormatter HOT 8
- Overly strict warning when curating a module under a technology root HOT 19
- Line numbers in code listings HOT 3
- The wrong role is assigned to the technology-root node in article-only catalogs
- Any way to merge the index.json for multiple framework hosting on single Static site ? HOT 8
- Provide `@Embed` directive as an equivalent of HTML <embed/> or <iframe/>
- Swift-DocC should display C++ and Objective-C++ as their own source languages
- Sitemap for DocC Hosted Website HOT 6
- source link line number mismatch HOT 2
- Support svg images in Xcode inline documentation HOT 2
- Pass "link summaries" instead of "resolved information" in external documentation source responses
- Can't document - -= / /= operators HOT 8
- DocC generates inconsistent output for global Objective-C functions that are renamed to be associated with a type in Swift HOT 2
- Error when publishing to GitHub Pages HOT 6
- Linkable glossary
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.