Skip to content

v2.0.0#125

Merged
antoniogamiz merged 45 commits intomasterfrom
develop
Jul 29, 2020
Merged

v2.0.0#125
antoniogamiz merged 45 commits intomasterfrom
develop

Conversation

@antoniogamiz
Copy link
Collaborator

Fixed bugs:

  • Documentable uses the default template instead of the template that's in the current directory. #102
  • Pod::To::HTML version #100
  • Classes with colons on the middle do not have the GitHub URL right #87
  • Some web pages in this site do not seem to be rendered #76

Closed issues:

  • Inspect the documentation of this repo and fix typos #77
  • Either make config required in Documentable::To::HTML::Wrapper or add reasonable defaults #66
  • Homepage menu generation is hardcoded #63
  • Give config.json a less generic name #62
  • New options to work with the default cache #34
  • Documentable freezes when node is not present #27
  • Use a real templating engine #19
  • Index pages descriptions #6
  • You can either install the sass command... #4

Merged pull requests:

antoniogamiz and others added 30 commits July 6, 2020 18:52
- `documentable update` is still broken due to
   finanalyst/raku-pod-from-cache/issues/4 Each update test will have
   to be done in a separate file or some similar hack
-  `use-cache` option has been deleted, so the use of the cache will
   be enforced.
Before this change we used "filename" attribute to look for the
Primary object updated. The problem is that, that "filename" is,
in general:

- Not unique, there could be two different pod6 files with the same
name, but in different subdirectories.
- No canonical. For instance, the filename of a Type is X::Something,
instead of X/Something.pod6.

To avoid these problems we use an absolute path for each pod6 file,
`source-path`. `Pod::From::Cache` returns paths relatives to the working
directory of the cache, so they need to be converted to `absolute`.
It always used the default (installed alongside Perl6::TypeGraph)
- Documentation is no longer published using circleci.
- A new github actions has been set up. This action will be run
  in new pushes to master and develop, and in PR to master. This
  actions will:
  - Build the base container of Documentable
  - Build a nightly version of Documentable
  - Publish doc using the nightly version
  - Run some tests (not implemented yet)
- testing-docker action has been supersed by the last one.
- Now you can specify what version of Documentable (production or
  nightly) you want to build using $branch_name buildarg.
We generate around 1700 html files, with basically the same menu and
submenu for every page (except for the selected entry). With this
change, we reduce the processing time of Template::Mustache.
We generate around 1700 html files, with basically the same menu and
submenu for every page (except for the selected entry). With this
change, we reduce the processing time of Template::Mustache.
Now the default template has two different template specifications,
but hey, it's faster.
If you use 'visibility', the contents will expand the parent box leaving
a gap. However, 'display' does not render the div block at all.

Refs: #117
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants