Comments (3)
It also isn't really clear what #a directives are supposed to do.
Do they affect the generated output directly or something else?
from statiq.docs.
If I reference a solution do I need to reference its projects as well?
Which build configuration will it use from the solution - debug or release? The first one? Whichever is currently selected in Visual Studio?
from statiq.docs.
Great questions
It also isn't really clear what #a directives are supposed to do
#a
adds an assembly to the references for the config file. For example, if you wanted to read JSON code inside your configuration file and had a local copy of Newtonsoft you wanted to reference. #a
does not impact your documentation or load assemblies for analysis in the docs.
If I reference a solution do I need to reference its projects as well?
You shouldn’t need to - using a solution for docs should document all the projects in that solution. Let me know if you find otherwise.
Which build configuration will it use from the solution - debug or release?
It’ll do whatever’s defined in the project file as the default, essentially it runs dotnet build proj.csproj
(or msbuild proj.csproj
) for each project in the solution. It doesn’t do any further solution parsing like figuring out VS build configurations.
from statiq.docs.
Related Issues (20)
- Make sure to escape all non-path chars in symbol names for docs
- Deconflict output files for symbols differing only by case in docs
- Docs Recipe - no setting for includeProtected (AnalyzeCSharp.WherePublic)
- Nested types cause URL conflicts for Docs recipe HOT 1
- Docs search breaks on digits
- Material theme for docs HOT 2
- Add xrefs for all API symbols
- Support for Markdown format
- Verify doc comments specification HOT 1
- Feature Request: support XML <include> tags
- GetTypeLink fails for tuples HOT 6
- Add support for automatically linking symbols
- Add support for langword
- Add the props file from Statiq.Web to Statiq.Docs HOT 2
- AddAssemblyFiles to populate "API"?
- Source files are ignored by generator HOT 11
- Xrefs for API symbols should not contain whitespace
- Methods from base class not listed if base class is generic
- Example on Statiq.Docs output HOT 1
- File Casing issue when deploying to GH-Pages HOT 1
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 statiq.docs.