Comments (12)
OK, I will add this to the todo list now.
But I think it might not be implemented soon.
The last question: how to determine your private packages?
The packages in the current directory?
from golds.
Yep, exactly, packages in the current directory.
from golds.
@cristaloleg
Could you elaborate more?
Is the idea the same as the ones described in #9 and #3?
from golds.
ping @cristaloleg
from golds.
Woah, have missed your previous comment. So, my case was "I want to collect all the declarations in 1 HTML file".
Suppose I've a Go module with 3 packages foo
, bar
and bar/baz
. In the end I would like to have doc.html
with foo
, bar
and bar/baz
documentation (funcs, types, consts, etc).
I don't think it's the same as #3 or #9
from golds.
Is it supposed for one module or for all parsed packages?
The page might be very long. So if it is created, it might be best to list the items as an index table.
from golds.
Yep, well, there was a filter to skip mocks or few codegen packages.
Agree, it can be long, but you've 1 doc which is super easy to grep and host (not the best cast but was good solution for one of our projects and non-tech team).
from golds.
So it is a page merged all package pages.
The page shouldn't include std packages, right?
And how about other 3rd-party dependency packages?
Is it ok to link their items to pkg.go.dev?
And how to handle source code pages?
To avoid generating source code pages, is it acceptable to link source code to external websites?
If std and 3rd-party dependencies are excluded, using external source code, and disabling some other features (id-ref pages and method-implementation pages), it might be feasible for small Go modules.
from golds.
Exactly.
No std packages (however this can be a good feature, but most cases will exclude stdlib).
No deps or vendor, only private repos.
What do you mean by linking items to pkg.go.dev?
Source code pages was linked to the local machine, so running doc generator will produce local working HTML page.
from golds.
What do you mean by linking items to pkg.go.dev?
In package doc pages, there are many links to other packages. It might be not a good idea to disable these links,
And currently, Golds will generate a page for each source code file.
And there are many links from package docs pages to source code pages.
As you only need one page, I think you might don't want the source code pages to be generated.
So is it ok to change the links to external source code hosting websites?
from golds.
As you only need one page, I think you might don't want the source code pages to be generated.
So is it ok to change the links to external source code hosting websites?
Aha, it looks this is an overthinking.
But should the source code pages of your private projects be generated?
If not, then the links from you package doc page to these source code pages will be disabled.
from golds.
Probably should be, but this was out of scope for my original questions :)
from golds.
Related Issues (20)
- Incorrect file names of generated HTML files HOT 3
- panic: writeExternalSourceCodeLink error: buildExternelSourceLink: source file github.com/PagerDuty^9f750/go-pagerduty/client.go not found HOT 6
- Allow passing a list of packages to be included HOT 6
- Golds v0.4.2 does not find go files HOT 19
- Escaping HTML tags HOT 2
- Panic with cold mod cache HOT 1
- Support Go 1.19 godoc formatting HOT 7
- panic with 0.5.0 HOT 1
- cannot get/install on go 1.17 HOT 1
- Selectors not collected from embedding instantiated types HOT 1
- Support dark theme HOT 3
- On Windows, fail to auto choose server port if the preferred port is used. HOT 1
- it doesn't seem to see submodules HOT 7
- Panic with Go 1.20.3 HOT 13
- Panic with go 1.21 HOT 4
- footer option doesn't work HOT 1
- Feature request: skip standard packages HOT 3
- expand all
- panic: should not HOT 3
- Show version tag of package? 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 golds.